types

package
v1.0.0-preview.18 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 7, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type CapabilityConfiguration 

type CapabilityConfiguration interface {
	// contains filtered or unexported methods
}

A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

The following types satisfy this interface: 

CapabilityConfigurationMemberEdi
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/b2bi/types"
)

func main() {
	var union types.CapabilityConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CapabilityConfigurationMemberEdi:
		_ = v.Value // Value is types.EdiConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type CapabilityConfigurationMemberEdi 

type CapabilityConfigurationMemberEdi struct {
	Value EdiConfiguration
	// contains filtered or unexported fields
}

An EDI (electronic data interchange) configuration object.

type CapabilitySummary 

type CapabilitySummary struct {

	// Returns a system-assigned unique identifier for the capability.
	//
	// This member is required.
	CapabilityId *string

	// Returns a timestamp for creation date and time of the capability.
	//
	// This member is required.
	CreatedAt *time.Time

	// The display name of the capability.
	//
	// This member is required.
	Name *string

	// Returns the type of the capability. Currently, only edi is supported.
	//
	// This member is required.
	Type CapabilityType

	// Returns a timestamp that identifies the most recent date and time that the
	// capability was modified.
	ModifiedAt *time.Time
	// contains filtered or unexported fields
}

Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

type CapabilityType 

type CapabilityType string
const (
	CapabilityTypeEdi CapabilityType = "edi"
)

Enum values for CapabilityType

func (CapabilityType) Values 

func (CapabilityType) Values() []CapabilityType

Values returns all known values for CapabilityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type EdiConfiguration 

type EdiConfiguration struct {

	// Contains the Amazon S3 bucket and prefix for the location of the input file,
	// which is contained in an S3Location object.
	//
	// This member is required.
	InputLocation *S3Location

	// Contains the Amazon S3 bucket and prefix for the location of the output file,
	// which is contained in an S3Location object.
	//
	// This member is required.
	OutputLocation *S3Location

	// Returns the system-assigned unique identifier for the transformer.
	//
	// This member is required.
	TransformerId *string

	// Returns the type of the capability. Currently, only edi is supported.
	//
	// This member is required.
	Type EdiType
	// contains filtered or unexported fields
}

Specifies the details for the EDI (electronic data interchange) transformation.

type EdiType 

type EdiType interface {
	// contains filtered or unexported methods
}

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.

The following types satisfy this interface: 

EdiTypeMemberX12Details
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/b2bi/types"
)

func main() {
	var union types.EdiType
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.EdiTypeMemberX12Details:
		_ = v.Value // Value is types.X12Details

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type EdiTypeMemberX12Details 

type EdiTypeMemberX12Details struct {
	Value X12Details
	// contains filtered or unexported fields
}

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.

type FileFormat 

type FileFormat string
const (
	FileFormatXml  FileFormat = "XML"
	FileFormatJson FileFormat = "JSON"
)

Enum values for FileFormat

func (FileFormat) Values 

func (FileFormat) Values() []FileFormat

Values returns all known values for FileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type Logging 

type Logging string
const (
	LoggingEnabled  Logging = "ENABLED"
	LoggingDisabled Logging = "DISABLED"
)

Enum values for Logging

func (Logging) Values 

func (Logging) Values() []Logging

Values returns all known values for Logging. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PartnershipSummary 

type PartnershipSummary struct {

	// Returns a timestamp for creation date and time of the partnership.
	//
	// This member is required.
	CreatedAt *time.Time

	// Returns the unique, system-generated identifier for a partnership.
	//
	// This member is required.
	PartnershipId *string

	// Returns the unique, system-generated identifier for the profile connected to
	// this partnership.
	//
	// This member is required.
	ProfileId *string

	// Returns one or more capabilities associated with this partnership.
	Capabilities []string

	// Returns a timestamp that identifies the most recent date and time that the
	// partnership was modified.
	ModifiedAt *time.Time

	// Returns the name of the partnership.
	Name *string

	// Returns the unique, system-generated identifier for a trading partner.
	TradingPartnerId *string
	// contains filtered or unexported fields
}

A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

type ProfileSummary 

type ProfileSummary struct {

	// Returns the name for the business associated with this profile.
	//
	// This member is required.
	BusinessName *string

	// Returns the timestamp for creation date and time of the profile.
	//
	// This member is required.
	CreatedAt *time.Time

	// Returns the display name for profile.
	//
	// This member is required.
	Name *string

	// Returns the unique, system-generated identifier for the profile.
	//
	// This member is required.
	ProfileId *string

	// Returns the name of the logging group.
	LogGroupName *string

	// Specifies whether or not logging is enabled for this profile.
	Logging Logging

	// Returns the timestamp that identifies the most recent date and time that the
	// profile was modified.
	ModifiedAt *time.Time
	// contains filtered or unexported fields
}

Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3Location 

type S3Location struct {

	// Specifies the name of the Amazon S3 bucket.
	BucketName *string

	// Specifies the Amazon S3 key for the file location.
	Key *string
	// contains filtered or unexported fields
}

Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Tag 

type Tag struct {

	// Specifies the name assigned to the tag that you create.
	//
	// This member is required.
	Key *string

	// Contains one or more values that you assigned to the key name that you create.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TransformerJobStatus 

type TransformerJobStatus string
const (
	TransformerJobStatusRunning   TransformerJobStatus = "running"
	TransformerJobStatusSucceeded TransformerJobStatus = "succeeded"
	TransformerJobStatusFailed    TransformerJobStatus = "failed"
)

Enum values for TransformerJobStatus

func (TransformerJobStatus) Values 

func (TransformerJobStatus) Values() []TransformerJobStatus

Values returns all known values for TransformerJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TransformerStatus 

type TransformerStatus string
const (
	TransformerStatusActive   TransformerStatus = "active"
	TransformerStatusInactive TransformerStatus = "inactive"
)

Enum values for TransformerStatus

func (TransformerStatus) Values 

func (TransformerStatus) Values() []TransformerStatus

Values returns all known values for TransformerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TransformerSummary 

type TransformerSummary struct {

	// Returns a timestamp indicating when the transformer was created. For example,
	// 2023-07-20T19:58:44.624Z .
	//
	// This member is required.
	CreatedAt *time.Time

	// 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.
	//
	// This member is required.
	EdiType EdiType

	// Returns that the currently supported file formats for EDI transformations are
	// JSON and XML .
	//
	// This member is required.
	FileFormat FileFormat

	// Returns the name of the mapping template for the transformer. This template is
	// used to convert the input document into the correct set of objects.
	//
	// This member is required.
	MappingTemplate *string

	// Returns the descriptive name for the transformer.
	//
	// This member is required.
	Name *string

	// 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 .
	//
	// This member is required.
	Status TransformerStatus

	// Returns the system-assigned unique identifier for the transformer.
	//
	// This member is required.
	TransformerId *string

	// Returns a timestamp representing the date and time for the most recent change
	// for the transformer object.
	ModifiedAt *time.Time

	// Returns a sample EDI document that is used by a transformer as a guide for
	// processing the EDI data.
	SampleDocument *string
	// contains filtered or unexported fields
}

Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when a B2BI object cannot be validated against a request from another object.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type X12Details 

type X12Details struct {

	// Returns an enumerated type where each value identifies an X12 transaction set.
	// Transaction sets are maintained by the X12 Accredited Standards Committee.
	TransactionSet X12TransactionSet

	// Returns the version to use for the specified X12 transaction set. Supported
	// versions are 4010 , 4030 , and 5010 .
	Version X12Version
	// contains filtered or unexported fields
}

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

type X12TransactionSet 

type X12TransactionSet string
const (
	X12TransactionSetX12110 X12TransactionSet = "X12_110"
	X12TransactionSetX12180 X12TransactionSet = "X12_180"
	X12TransactionSetX12204 X12TransactionSet = "X12_204"
	X12TransactionSetX12210 X12TransactionSet = "X12_210"
	X12TransactionSetX12214 X12TransactionSet = "X12_214"
	X12TransactionSetX12215 X12TransactionSet = "X12_215"
	X12TransactionSetX12310 X12TransactionSet = "X12_310"
	X12TransactionSetX12315 X12TransactionSet = "X12_315"
	X12TransactionSetX12322 X12TransactionSet = "X12_322"
	X12TransactionSetX12404 X12TransactionSet = "X12_404"
	X12TransactionSetX12410 X12TransactionSet = "X12_410"
	X12TransactionSetX12820 X12TransactionSet = "X12_820"
	X12TransactionSetX12824 X12TransactionSet = "X12_824"
	X12TransactionSetX12830 X12TransactionSet = "X12_830"
	X12TransactionSetX12846 X12TransactionSet = "X12_846"
	X12TransactionSetX12850 X12TransactionSet = "X12_850"
	X12TransactionSetX12852 X12TransactionSet = "X12_852"
	X12TransactionSetX12855 X12TransactionSet = "X12_855"
	X12TransactionSetX12856 X12TransactionSet = "X12_856"
	X12TransactionSetX12860 X12TransactionSet = "X12_860"
	X12TransactionSetX12861 X12TransactionSet = "X12_861"
	X12TransactionSetX12864 X12TransactionSet = "X12_864"
	X12TransactionSetX12940 X12TransactionSet = "X12_940"
	X12TransactionSetX12990 X12TransactionSet = "X12_990"
	X12TransactionSetX12997 X12TransactionSet = "X12_997"
)

Enum values for X12TransactionSet

func (X12TransactionSet) Values 

func (X12TransactionSet) Values() []X12TransactionSet

Values returns all known values for X12TransactionSet. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type X12Version 

type X12Version string
const (
	X12VersionVersion4010 X12Version = "VERSION_4010"
	X12VersionVersion4030 X12Version = "VERSION_4030"
	X12VersionVersion5010 X12Version = "VERSION_5010"
)

Enum values for X12Version

func (X12Version) Values 

func (X12Version) Values() []X12Version

Values returns all known values for X12Version. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.