Documentation ¶
Overview ¶
Package supplychain provides the client and types for making API requests to AWS Supply Chain.
AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.
The AWS Supply Chain API supports configuration data import for Supply Planning.
All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.
See https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01 for more information on this service.
See supplychain package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/supplychain/
Using the Client ¶
To contact AWS Supply Chain with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Supply Chain client SupplyChain for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/supplychain/#New
Index ¶
- Constants
- func ConfigurationJobStatus_Values() []string
- func DataIntegrationEventType_Values() []string
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type BillOfMaterialsImportJob
- func (s BillOfMaterialsImportJob) GoString() string
- func (s *BillOfMaterialsImportJob) SetInstanceId(v string) *BillOfMaterialsImportJob
- func (s *BillOfMaterialsImportJob) SetJobId(v string) *BillOfMaterialsImportJob
- func (s *BillOfMaterialsImportJob) SetMessage(v string) *BillOfMaterialsImportJob
- func (s *BillOfMaterialsImportJob) SetS3uri(v string) *BillOfMaterialsImportJob
- func (s *BillOfMaterialsImportJob) SetStatus(v string) *BillOfMaterialsImportJob
- func (s BillOfMaterialsImportJob) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type CreateBillOfMaterialsImportJobInput
- func (s CreateBillOfMaterialsImportJobInput) GoString() string
- func (s *CreateBillOfMaterialsImportJobInput) SetClientToken(v string) *CreateBillOfMaterialsImportJobInput
- func (s *CreateBillOfMaterialsImportJobInput) SetInstanceId(v string) *CreateBillOfMaterialsImportJobInput
- func (s *CreateBillOfMaterialsImportJobInput) SetS3uri(v string) *CreateBillOfMaterialsImportJobInput
- func (s CreateBillOfMaterialsImportJobInput) String() string
- func (s *CreateBillOfMaterialsImportJobInput) Validate() error
- type CreateBillOfMaterialsImportJobOutput
- type GetBillOfMaterialsImportJobInput
- func (s GetBillOfMaterialsImportJobInput) GoString() string
- func (s *GetBillOfMaterialsImportJobInput) SetInstanceId(v string) *GetBillOfMaterialsImportJobInput
- func (s *GetBillOfMaterialsImportJobInput) SetJobId(v string) *GetBillOfMaterialsImportJobInput
- func (s GetBillOfMaterialsImportJobInput) String() string
- func (s *GetBillOfMaterialsImportJobInput) Validate() error
- type GetBillOfMaterialsImportJobOutput
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type SendDataIntegrationEventInput
- func (s SendDataIntegrationEventInput) GoString() string
- func (s *SendDataIntegrationEventInput) SetClientToken(v string) *SendDataIntegrationEventInput
- func (s *SendDataIntegrationEventInput) SetData(v string) *SendDataIntegrationEventInput
- func (s *SendDataIntegrationEventInput) SetEventGroupId(v string) *SendDataIntegrationEventInput
- func (s *SendDataIntegrationEventInput) SetEventTimestamp(v time.Time) *SendDataIntegrationEventInput
- func (s *SendDataIntegrationEventInput) SetEventType(v string) *SendDataIntegrationEventInput
- func (s *SendDataIntegrationEventInput) SetInstanceId(v string) *SendDataIntegrationEventInput
- func (s SendDataIntegrationEventInput) String() string
- func (s *SendDataIntegrationEventInput) Validate() error
- type SendDataIntegrationEventOutput
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type SupplyChain
- func (c *SupplyChain) CreateBillOfMaterialsImportJob(input *CreateBillOfMaterialsImportJobInput) (*CreateBillOfMaterialsImportJobOutput, error)
- func (c *SupplyChain) CreateBillOfMaterialsImportJobRequest(input *CreateBillOfMaterialsImportJobInput) (req *request.Request, output *CreateBillOfMaterialsImportJobOutput)
- func (c *SupplyChain) CreateBillOfMaterialsImportJobWithContext(ctx aws.Context, input *CreateBillOfMaterialsImportJobInput, ...) (*CreateBillOfMaterialsImportJobOutput, error)
- func (c *SupplyChain) GetBillOfMaterialsImportJob(input *GetBillOfMaterialsImportJobInput) (*GetBillOfMaterialsImportJobOutput, error)
- func (c *SupplyChain) GetBillOfMaterialsImportJobRequest(input *GetBillOfMaterialsImportJobInput) (req *request.Request, output *GetBillOfMaterialsImportJobOutput)
- func (c *SupplyChain) GetBillOfMaterialsImportJobWithContext(ctx aws.Context, input *GetBillOfMaterialsImportJobInput, ...) (*GetBillOfMaterialsImportJobOutput, error)
- func (c *SupplyChain) SendDataIntegrationEvent(input *SendDataIntegrationEventInput) (*SendDataIntegrationEventOutput, error)
- func (c *SupplyChain) SendDataIntegrationEventRequest(input *SendDataIntegrationEventInput) (req *request.Request, output *SendDataIntegrationEventOutput)
- func (c *SupplyChain) SendDataIntegrationEventWithContext(ctx aws.Context, input *SendDataIntegrationEventInput, opts ...request.Option) (*SendDataIntegrationEventOutput, error)
- type ThrottlingException
- func (s *ThrottlingException) Code() string
- func (s *ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s *ThrottlingException) Message() string
- func (s *ThrottlingException) OrigErr() error
- func (s *ThrottlingException) RequestID() string
- func (s *ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
Examples ¶
- SupplyChain.CreateBillOfMaterialsImportJob (Shared00)
- SupplyChain.GetBillOfMaterialsImportJob (Shared00)
- SupplyChain.GetBillOfMaterialsImportJob (Shared01)
- SupplyChain.SendDataIntegrationEvent (Shared00)
- SupplyChain.SendDataIntegrationEvent (Shared01)
- SupplyChain.SendDataIntegrationEvent (Shared02)
- SupplyChain.SendDataIntegrationEvent (Shared03)
- SupplyChain.SendDataIntegrationEvent (Shared04)
- SupplyChain.SendDataIntegrationEvent (Shared05)
- SupplyChain.SendDataIntegrationEvent (Shared06)
- SupplyChain.SendDataIntegrationEvent (Shared07)
- SupplyChain.SendDataIntegrationEvent (Shared08)
- SupplyChain.SendDataIntegrationEvent (Shared09)
- SupplyChain.SendDataIntegrationEvent (Shared10)
- SupplyChain.SendDataIntegrationEvent (Shared11)
- SupplyChain.SendDataIntegrationEvent (Shared12)
- SupplyChain.SendDataIntegrationEvent (Shared13)
- SupplyChain.SendDataIntegrationEvent (Shared14)
Constants ¶
const ( // ConfigurationJobStatusNew is a ConfigurationJobStatus enum value ConfigurationJobStatusNew = "NEW" // ConfigurationJobStatusFailed is a ConfigurationJobStatus enum value ConfigurationJobStatusFailed = "FAILED" // ConfigurationJobStatusInProgress is a ConfigurationJobStatus enum value ConfigurationJobStatusInProgress = "IN_PROGRESS" // ConfigurationJobStatusQueued is a ConfigurationJobStatus enum value ConfigurationJobStatusQueued = "QUEUED" // ConfigurationJobStatusSuccess is a ConfigurationJobStatus enum value ConfigurationJobStatusSuccess = "SUCCESS" )
The status of the job.
const ( // DataIntegrationEventTypeScnDataForecast is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataForecast = "scn.data.forecast" // DataIntegrationEventTypeScnDataInventorylevel is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataInventorylevel = "scn.data.inventorylevel" // DataIntegrationEventTypeScnDataInboundorder is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataInboundorder = "scn.data.inboundorder" // DataIntegrationEventTypeScnDataInboundorderline is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataInboundorderline = "scn.data.inboundorderline" // DataIntegrationEventTypeScnDataInboundorderlineschedule is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataInboundorderlineschedule = "scn.data.inboundorderlineschedule" // DataIntegrationEventTypeScnDataOutboundorderline is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataOutboundorderline = "scn.data.outboundorderline" // DataIntegrationEventTypeScnDataOutboundshipment is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataOutboundshipment = "scn.data.outboundshipment" // DataIntegrationEventTypeScnDataProcessheader is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataProcessheader = "scn.data.processheader" // DataIntegrationEventTypeScnDataProcessoperation is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataProcessoperation = "scn.data.processoperation" // DataIntegrationEventTypeScnDataProcessproduct is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataProcessproduct = "scn.data.processproduct" // DataIntegrationEventTypeScnDataReservation is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataReservation = "scn.data.reservation" // DataIntegrationEventTypeScnDataShipment is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataShipment = "scn.data.shipment" // DataIntegrationEventTypeScnDataShipmentstop is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataShipmentstop = "scn.data.shipmentstop" // DataIntegrationEventTypeScnDataShipmentstoporder is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataShipmentstoporder = "scn.data.shipmentstoporder" // DataIntegrationEventTypeScnDataSupplyplan is a DataIntegrationEventType enum value DataIntegrationEventTypeScnDataSupplyplan = "scn.data.supplyplan" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have the required privileges to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // // Updating or deleting a resource can cause an inconsistent state. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // Unexpected error during processing of request. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // Request references a resource which does not exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // Request would cause a service quota to be exceeded. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // Request was denied due to request throttling. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // The input does not satisfy the constraints specified by an AWS service. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "SupplyChain" // Name of service. EndpointsID = "scn" // ID to lookup a service endpoint with. ServiceID = "SupplyChain" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func ConfigurationJobStatus_Values ¶
func ConfigurationJobStatus_Values() []string
ConfigurationJobStatus_Values returns all elements of the ConfigurationJobStatus enum
func DataIntegrationEventType_Values ¶ added in v1.51.19
func DataIntegrationEventType_Values() []string
DataIntegrationEventType_Values returns all elements of the DataIntegrationEventType enum
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You do not have the required privileges to perform this action.
func (*AccessDeniedException) Code ¶
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (*AccessDeniedException) Error ¶
func (s *AccessDeniedException) Error() string
func (AccessDeniedException) GoString ¶
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AccessDeniedException) Message ¶
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (*AccessDeniedException) OrigErr ¶
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*AccessDeniedException) RequestID ¶
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*AccessDeniedException) StatusCode ¶
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (AccessDeniedException) String ¶
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BillOfMaterialsImportJob ¶
type BillOfMaterialsImportJob struct { // The BillOfMaterialsImportJob instanceId. // // InstanceId is a required field InstanceId *string `locationName:"instanceId" min:"36" type:"string" required:"true"` // The BillOfMaterialsImportJob jobId. // // JobId is a required field JobId *string `locationName:"jobId" min:"36" type:"string" required:"true"` // When the BillOfMaterialsImportJob has reached a terminal state, there will // be a message. Message *string `locationName:"message" type:"string"` // The S3 URI from which the CSV is read. // // S3uri is a required field S3uri *string `locationName:"s3uri" min:"10" type:"string" required:"true"` // The BillOfMaterialsImportJob ConfigurationJobStatus. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"ConfigurationJobStatus"` // contains filtered or unexported fields }
The BillOfMaterialsImportJob details.
func (BillOfMaterialsImportJob) GoString ¶
func (s BillOfMaterialsImportJob) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*BillOfMaterialsImportJob) SetInstanceId ¶
func (s *BillOfMaterialsImportJob) SetInstanceId(v string) *BillOfMaterialsImportJob
SetInstanceId sets the InstanceId field's value.
func (*BillOfMaterialsImportJob) SetJobId ¶
func (s *BillOfMaterialsImportJob) SetJobId(v string) *BillOfMaterialsImportJob
SetJobId sets the JobId field's value.
func (*BillOfMaterialsImportJob) SetMessage ¶
func (s *BillOfMaterialsImportJob) SetMessage(v string) *BillOfMaterialsImportJob
SetMessage sets the Message field's value.
func (*BillOfMaterialsImportJob) SetS3uri ¶
func (s *BillOfMaterialsImportJob) SetS3uri(v string) *BillOfMaterialsImportJob
SetS3uri sets the S3uri field's value.
func (*BillOfMaterialsImportJob) SetStatus ¶
func (s *BillOfMaterialsImportJob) SetStatus(v string) *BillOfMaterialsImportJob
SetStatus sets the Status field's value.
func (BillOfMaterialsImportJob) String ¶
func (s BillOfMaterialsImportJob) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException ¶
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Updating or deleting a resource can cause an inconsistent state.
func (*ConflictException) Code ¶
func (s *ConflictException) Code() string
Code returns the exception type name.
func (*ConflictException) Error ¶
func (s *ConflictException) Error() string
func (ConflictException) GoString ¶
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ConflictException) Message ¶
func (s *ConflictException) Message() string
Message returns the exception's message.
func (*ConflictException) OrigErr ¶
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ConflictException) RequestID ¶
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ConflictException) StatusCode ¶
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateBillOfMaterialsImportJobInput ¶
type CreateBillOfMaterialsImportJobInput struct { // An idempotency token. ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` // The AWS Supply Chain instance identifier. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"instanceId" min:"36" type:"string" required:"true"` // The S3 URI of the CSV file to be imported. The bucket must grant permissions // for AWS Supply Chain to read the file. // // S3uri is a required field S3uri *string `locationName:"s3uri" min:"10" type:"string" required:"true"` // contains filtered or unexported fields }
The request parameters for CreateBillOfMaterialsImportJob.
func (CreateBillOfMaterialsImportJobInput) GoString ¶
func (s CreateBillOfMaterialsImportJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateBillOfMaterialsImportJobInput) SetClientToken ¶
func (s *CreateBillOfMaterialsImportJobInput) SetClientToken(v string) *CreateBillOfMaterialsImportJobInput
SetClientToken sets the ClientToken field's value.
func (*CreateBillOfMaterialsImportJobInput) SetInstanceId ¶
func (s *CreateBillOfMaterialsImportJobInput) SetInstanceId(v string) *CreateBillOfMaterialsImportJobInput
SetInstanceId sets the InstanceId field's value.
func (*CreateBillOfMaterialsImportJobInput) SetS3uri ¶
func (s *CreateBillOfMaterialsImportJobInput) SetS3uri(v string) *CreateBillOfMaterialsImportJobInput
SetS3uri sets the S3uri field's value.
func (CreateBillOfMaterialsImportJobInput) String ¶
func (s CreateBillOfMaterialsImportJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateBillOfMaterialsImportJobInput) Validate ¶
func (s *CreateBillOfMaterialsImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBillOfMaterialsImportJobOutput ¶
type CreateBillOfMaterialsImportJobOutput struct { // The new BillOfMaterialsImportJob identifier. // // JobId is a required field JobId *string `locationName:"jobId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
The response parameters of CreateBillOfMaterialsImportJob.
func (CreateBillOfMaterialsImportJobOutput) GoString ¶
func (s CreateBillOfMaterialsImportJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateBillOfMaterialsImportJobOutput) SetJobId ¶
func (s *CreateBillOfMaterialsImportJobOutput) SetJobId(v string) *CreateBillOfMaterialsImportJobOutput
SetJobId sets the JobId field's value.
func (CreateBillOfMaterialsImportJobOutput) String ¶
func (s CreateBillOfMaterialsImportJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetBillOfMaterialsImportJobInput ¶
type GetBillOfMaterialsImportJobInput struct { // The AWS Supply Chain instance identifier. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"instanceId" min:"36" type:"string" required:"true"` // The BillOfMaterialsImportJob identifier. // // JobId is a required field JobId *string `location:"uri" locationName:"jobId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
The request parameters for GetBillOfMaterialsImportJob.
func (GetBillOfMaterialsImportJobInput) GoString ¶
func (s GetBillOfMaterialsImportJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetBillOfMaterialsImportJobInput) SetInstanceId ¶
func (s *GetBillOfMaterialsImportJobInput) SetInstanceId(v string) *GetBillOfMaterialsImportJobInput
SetInstanceId sets the InstanceId field's value.
func (*GetBillOfMaterialsImportJobInput) SetJobId ¶
func (s *GetBillOfMaterialsImportJobInput) SetJobId(v string) *GetBillOfMaterialsImportJobInput
SetJobId sets the JobId field's value.
func (GetBillOfMaterialsImportJobInput) String ¶
func (s GetBillOfMaterialsImportJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetBillOfMaterialsImportJobInput) Validate ¶
func (s *GetBillOfMaterialsImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetBillOfMaterialsImportJobOutput ¶
type GetBillOfMaterialsImportJobOutput struct { // The BillOfMaterialsImportJob. // // Job is a required field Job *BillOfMaterialsImportJob `locationName:"job" type:"structure" required:"true"` // contains filtered or unexported fields }
The response parameters for GetBillOfMaterialsImportJob.
func (GetBillOfMaterialsImportJobOutput) GoString ¶
func (s GetBillOfMaterialsImportJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetBillOfMaterialsImportJobOutput) SetJob ¶
func (s *GetBillOfMaterialsImportJobOutput) SetJob(v *BillOfMaterialsImportJob) *GetBillOfMaterialsImportJobOutput
SetJob sets the Job field's value.
func (GetBillOfMaterialsImportJobOutput) String ¶
func (s GetBillOfMaterialsImportJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalServerException ¶
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Unexpected error during processing of request.
func (*InternalServerException) Code ¶
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (*InternalServerException) Error ¶
func (s *InternalServerException) Error() string
func (InternalServerException) GoString ¶
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InternalServerException) Message ¶
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (*InternalServerException) OrigErr ¶
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalServerException) RequestID ¶
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalServerException) StatusCode ¶
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServerException) String ¶
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Request references a resource which does not exist.
func (*ResourceNotFoundException) Code ¶
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (*ResourceNotFoundException) Error ¶
func (s *ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResourceNotFoundException) Message ¶
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (*ResourceNotFoundException) OrigErr ¶
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceNotFoundException) RequestID ¶
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceNotFoundException) StatusCode ¶
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SendDataIntegrationEventInput ¶ added in v1.51.19
type SendDataIntegrationEventInput struct { // The idempotent client token. ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` // The data payload of the event. // // Data is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by SendDataIntegrationEventInput's // String and GoString methods. // // Data is a required field Data *string `locationName:"data" min:"1" type:"string" required:"true" sensitive:"true"` // Event identifier (for example, orderId for InboundOrder) used for data sharing // or partitioning. // // EventGroupId is a required field EventGroupId *string `locationName:"eventGroupId" min:"1" type:"string" required:"true"` // The event timestamp (in epoch seconds). EventTimestamp *time.Time `locationName:"eventTimestamp" type:"timestamp" timestampFormat:"unixTimestamp"` // The data event type. // // EventType is a required field EventType *string `locationName:"eventType" type:"string" required:"true" enum:"DataIntegrationEventType"` // The AWS Supply Chain instance identifier. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"instanceId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
The request parameters for SendDataIntegrationEvent.
func (SendDataIntegrationEventInput) GoString ¶ added in v1.51.19
func (s SendDataIntegrationEventInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendDataIntegrationEventInput) SetClientToken ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetClientToken(v string) *SendDataIntegrationEventInput
SetClientToken sets the ClientToken field's value.
func (*SendDataIntegrationEventInput) SetData ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetData(v string) *SendDataIntegrationEventInput
SetData sets the Data field's value.
func (*SendDataIntegrationEventInput) SetEventGroupId ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetEventGroupId(v string) *SendDataIntegrationEventInput
SetEventGroupId sets the EventGroupId field's value.
func (*SendDataIntegrationEventInput) SetEventTimestamp ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetEventTimestamp(v time.Time) *SendDataIntegrationEventInput
SetEventTimestamp sets the EventTimestamp field's value.
func (*SendDataIntegrationEventInput) SetEventType ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetEventType(v string) *SendDataIntegrationEventInput
SetEventType sets the EventType field's value.
func (*SendDataIntegrationEventInput) SetInstanceId ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) SetInstanceId(v string) *SendDataIntegrationEventInput
SetInstanceId sets the InstanceId field's value.
func (SendDataIntegrationEventInput) String ¶ added in v1.51.19
func (s SendDataIntegrationEventInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendDataIntegrationEventInput) Validate ¶ added in v1.51.19
func (s *SendDataIntegrationEventInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendDataIntegrationEventOutput ¶ added in v1.51.19
type SendDataIntegrationEventOutput struct { // The unique event identifier. // // EventId is a required field EventId *string `locationName:"eventId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
The response parameters for SendDataIntegrationEvent.
func (SendDataIntegrationEventOutput) GoString ¶ added in v1.51.19
func (s SendDataIntegrationEventOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendDataIntegrationEventOutput) SetEventId ¶ added in v1.51.19
func (s *SendDataIntegrationEventOutput) SetEventId(v string) *SendDataIntegrationEventOutput
SetEventId sets the EventId field's value.
func (SendDataIntegrationEventOutput) String ¶ added in v1.51.19
func (s SendDataIntegrationEventOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Request would cause a service quota to be exceeded.
func (*ServiceQuotaExceededException) Code ¶
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (*ServiceQuotaExceededException) Error ¶
func (s *ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ServiceQuotaExceededException) Message ¶
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (*ServiceQuotaExceededException) OrigErr ¶
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ServiceQuotaExceededException) RequestID ¶
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ServiceQuotaExceededException) StatusCode ¶
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SupplyChain ¶
SupplyChain provides the API operation methods for making requests to AWS Supply Chain. See this package's package overview docs for details on the service.
SupplyChain methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *SupplyChain
New creates a new instance of the SupplyChain client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a SupplyChain client from just a session. svc := supplychain.New(mySession) // Create a SupplyChain client with additional configuration svc := supplychain.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*SupplyChain) CreateBillOfMaterialsImportJob ¶
func (c *SupplyChain) CreateBillOfMaterialsImportJob(input *CreateBillOfMaterialsImportJobInput) (*CreateBillOfMaterialsImportJobOutput, error)
CreateBillOfMaterialsImportJob API operation for AWS Supply Chain.
CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.
The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Supply Chain's API operation CreateBillOfMaterialsImportJob for usage and error information.
Returned Error Types:
ServiceQuotaExceededException Request would cause a service quota to be exceeded.
ThrottlingException Request was denied due to request throttling.
ResourceNotFoundException Request references a resource which does not exist.
AccessDeniedException You do not have the required privileges to perform this action.
ValidationException The input does not satisfy the constraints specified by an AWS service.
InternalServerException Unexpected error during processing of request.
ConflictException Updating or deleting a resource can cause an inconsistent state.
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateBillOfMaterialsImportJob
func (*SupplyChain) CreateBillOfMaterialsImportJobRequest ¶
func (c *SupplyChain) CreateBillOfMaterialsImportJobRequest(input *CreateBillOfMaterialsImportJobInput) (req *request.Request, output *CreateBillOfMaterialsImportJobOutput)
CreateBillOfMaterialsImportJobRequest generates a "aws/request.Request" representing the client's request for the CreateBillOfMaterialsImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateBillOfMaterialsImportJob for more information on using the CreateBillOfMaterialsImportJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateBillOfMaterialsImportJobRequest method. req, resp := client.CreateBillOfMaterialsImportJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/CreateBillOfMaterialsImportJob
func (*SupplyChain) CreateBillOfMaterialsImportJobWithContext ¶
func (c *SupplyChain) CreateBillOfMaterialsImportJobWithContext(ctx aws.Context, input *CreateBillOfMaterialsImportJobInput, opts ...request.Option) (*CreateBillOfMaterialsImportJobOutput, error)
CreateBillOfMaterialsImportJobWithContext is the same as CreateBillOfMaterialsImportJob with the addition of the ability to pass a context and additional request options.
See CreateBillOfMaterialsImportJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SupplyChain) GetBillOfMaterialsImportJob ¶
func (c *SupplyChain) GetBillOfMaterialsImportJob(input *GetBillOfMaterialsImportJobInput) (*GetBillOfMaterialsImportJobOutput, error)
GetBillOfMaterialsImportJob API operation for AWS Supply Chain.
Get status and details of a BillOfMaterialsImportJob.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Supply Chain's API operation GetBillOfMaterialsImportJob for usage and error information.
Returned Error Types:
ServiceQuotaExceededException Request would cause a service quota to be exceeded.
ResourceNotFoundException Request references a resource which does not exist.
ThrottlingException Request was denied due to request throttling.
AccessDeniedException You do not have the required privileges to perform this action.
ValidationException The input does not satisfy the constraints specified by an AWS service.
InternalServerException Unexpected error during processing of request.
ConflictException Updating or deleting a resource can cause an inconsistent state.
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetBillOfMaterialsImportJob
func (*SupplyChain) GetBillOfMaterialsImportJobRequest ¶
func (c *SupplyChain) GetBillOfMaterialsImportJobRequest(input *GetBillOfMaterialsImportJobInput) (req *request.Request, output *GetBillOfMaterialsImportJobOutput)
GetBillOfMaterialsImportJobRequest generates a "aws/request.Request" representing the client's request for the GetBillOfMaterialsImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetBillOfMaterialsImportJob for more information on using the GetBillOfMaterialsImportJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetBillOfMaterialsImportJobRequest method. req, resp := client.GetBillOfMaterialsImportJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/GetBillOfMaterialsImportJob
func (*SupplyChain) GetBillOfMaterialsImportJobWithContext ¶
func (c *SupplyChain) GetBillOfMaterialsImportJobWithContext(ctx aws.Context, input *GetBillOfMaterialsImportJobInput, opts ...request.Option) (*GetBillOfMaterialsImportJobOutput, error)
GetBillOfMaterialsImportJobWithContext is the same as GetBillOfMaterialsImportJob with the addition of the ability to pass a context and additional request options.
See GetBillOfMaterialsImportJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SupplyChain) SendDataIntegrationEvent ¶ added in v1.51.19
func (c *SupplyChain) SendDataIntegrationEvent(input *SendDataIntegrationEventInput) (*SendDataIntegrationEventOutput, error)
SendDataIntegrationEvent API operation for AWS Supply Chain.
Send transactional data events with real-time data for analysis or monitoring.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Supply Chain's API operation SendDataIntegrationEvent for usage and error information.
Returned Error Types:
ServiceQuotaExceededException Request would cause a service quota to be exceeded.
ResourceNotFoundException Request references a resource which does not exist.
ThrottlingException Request was denied due to request throttling.
AccessDeniedException You do not have the required privileges to perform this action.
ValidationException The input does not satisfy the constraints specified by an AWS service.
InternalServerException Unexpected error during processing of request.
ConflictException Updating or deleting a resource can cause an inconsistent state.
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/SendDataIntegrationEvent
func (*SupplyChain) SendDataIntegrationEventRequest ¶ added in v1.51.19
func (c *SupplyChain) SendDataIntegrationEventRequest(input *SendDataIntegrationEventInput) (req *request.Request, output *SendDataIntegrationEventOutput)
SendDataIntegrationEventRequest generates a "aws/request.Request" representing the client's request for the SendDataIntegrationEvent operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SendDataIntegrationEvent for more information on using the SendDataIntegrationEvent API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SendDataIntegrationEventRequest method. req, resp := client.SendDataIntegrationEventRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/SendDataIntegrationEvent
func (*SupplyChain) SendDataIntegrationEventWithContext ¶ added in v1.51.19
func (c *SupplyChain) SendDataIntegrationEventWithContext(ctx aws.Context, input *SendDataIntegrationEventInput, opts ...request.Option) (*SendDataIntegrationEventOutput, error)
SendDataIntegrationEventWithContext is the same as SendDataIntegrationEvent with the addition of the ability to pass a context and additional request options.
See SendDataIntegrationEvent for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ThrottlingException ¶
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Request was denied due to request throttling.
func (*ThrottlingException) Code ¶
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (*ThrottlingException) Error ¶
func (s *ThrottlingException) Error() string
func (ThrottlingException) GoString ¶
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ThrottlingException) Message ¶
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (*ThrottlingException) OrigErr ¶
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ThrottlingException) RequestID ¶
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ThrottlingException) StatusCode ¶
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ThrottlingException) String ¶
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException ¶
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The input does not satisfy the constraints specified by an AWS service.
func (*ValidationException) Code ¶
func (s *ValidationException) Code() string
Code returns the exception type name.
func (*ValidationException) Error ¶
func (s *ValidationException) Error() string
func (ValidationException) GoString ¶
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ValidationException) Message ¶
func (s *ValidationException) Message() string
Message returns the exception's message.
func (*ValidationException) OrigErr ¶
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ValidationException) RequestID ¶
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ValidationException) StatusCode ¶
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ValidationException) String ¶
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
Directories ¶
Path | Synopsis |
---|---|
Package supplychainiface provides an interface to enable mocking the AWS Supply Chain service client for testing your code.
|
Package supplychainiface provides an interface to enable mocking the AWS Supply Chain service client for testing your code. |