supplychain

package module
v1.12.2 Latest Latest
Warning

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

Go to latest
Published: Apr 3, 2025 License: Apache-2.0 Imports: 45 Imported by: 5

Documentation

Overview

Package supplychain provides the API client, operations, and parameter types for 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.

Index

Constants

View Source
const ServiceAPIVersion = "2024-01-01"
View Source
const ServiceID = "SupplyChain"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Supply Chain.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateBillOfMaterialsImportJob

func (c *Client) CreateBillOfMaterialsImportJob(ctx context.Context, params *CreateBillOfMaterialsImportJobInput, optFns ...func(*Options)) (*CreateBillOfMaterialsImportJobOutput, error)

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.

func (*Client) CreateDataIntegrationFlow added in v1.7.0

func (c *Client) CreateDataIntegrationFlow(ctx context.Context, params *CreateDataIntegrationFlowInput, optFns ...func(*Options)) (*CreateDataIntegrationFlowOutput, error)

Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.

func (*Client) CreateDataLakeDataset added in v1.7.0

func (c *Client) CreateDataLakeDataset(ctx context.Context, params *CreateDataLakeDatasetInput, optFns ...func(*Options)) (*CreateDataLakeDatasetOutput, error)

Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.

func (*Client) CreateInstance added in v1.9.0

func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput, optFns ...func(*Options)) (*CreateInstanceOutput, error)

Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.

This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

func (*Client) DeleteDataIntegrationFlow added in v1.7.0

func (c *Client) DeleteDataIntegrationFlow(ctx context.Context, params *DeleteDataIntegrationFlowInput, optFns ...func(*Options)) (*DeleteDataIntegrationFlowOutput, error)

Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

func (*Client) DeleteDataLakeDataset added in v1.7.0

func (c *Client) DeleteDataLakeDataset(ctx context.Context, params *DeleteDataLakeDatasetInput, optFns ...func(*Options)) (*DeleteDataLakeDatasetOutput, error)

Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.

func (*Client) DeleteInstance added in v1.9.0

func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error)

Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.

This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.

func (*Client) GetBillOfMaterialsImportJob

func (c *Client) GetBillOfMaterialsImportJob(ctx context.Context, params *GetBillOfMaterialsImportJobInput, optFns ...func(*Options)) (*GetBillOfMaterialsImportJobOutput, error)

Get status and details of a BillOfMaterialsImportJob.

func (*Client) GetDataIntegrationFlow added in v1.7.0

func (c *Client) GetDataIntegrationFlow(ctx context.Context, params *GetDataIntegrationFlowInput, optFns ...func(*Options)) (*GetDataIntegrationFlowOutput, error)

Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

func (*Client) GetDataLakeDataset added in v1.7.0

func (c *Client) GetDataLakeDataset(ctx context.Context, params *GetDataLakeDatasetInput, optFns ...func(*Options)) (*GetDataLakeDatasetOutput, error)

Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.

func (*Client) GetInstance added in v1.9.0

func (c *Client) GetInstance(ctx context.Context, params *GetInstanceInput, optFns ...func(*Options)) (*GetInstanceOutput, error)

Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.

func (*Client) ListDataIntegrationFlows added in v1.7.0

func (c *Client) ListDataIntegrationFlows(ctx context.Context, params *ListDataIntegrationFlowsInput, optFns ...func(*Options)) (*ListDataIntegrationFlowsOutput, error)

Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.

func (*Client) ListDataLakeDatasets added in v1.7.0

func (c *Client) ListDataLakeDatasets(ctx context.Context, params *ListDataLakeDatasetsInput, optFns ...func(*Options)) (*ListDataLakeDatasetsOutput, error)

Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.

func (*Client) ListInstances added in v1.9.0

func (c *Client) ListInstances(ctx context.Context, params *ListInstancesInput, optFns ...func(*Options)) (*ListInstancesOutput, error)

List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).

func (*Client) ListTagsForResource added in v1.7.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.

func (*Client) Options

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) SendDataIntegrationEvent added in v1.3.0

func (c *Client) SendDataIntegrationEvent(ctx context.Context, params *SendDataIntegrationEventInput, optFns ...func(*Options)) (*SendDataIntegrationEventOutput, error)

Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.

func (*Client) TagResource added in v1.7.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.

func (*Client) UntagResource added in v1.7.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.

func (*Client) UpdateDataIntegrationFlow added in v1.7.0

func (c *Client) UpdateDataIntegrationFlow(ctx context.Context, params *UpdateDataIntegrationFlowInput, optFns ...func(*Options)) (*UpdateDataIntegrationFlowOutput, error)

Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.

func (*Client) UpdateDataLakeDataset added in v1.7.0

func (c *Client) UpdateDataLakeDataset(ctx context.Context, params *UpdateDataLakeDatasetInput, optFns ...func(*Options)) (*UpdateDataLakeDatasetOutput, error)

Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.

func (*Client) UpdateInstance added in v1.9.0

func (c *Client) UpdateInstance(ctx context.Context, params *UpdateInstanceInput, optFns ...func(*Options)) (*UpdateInstanceOutput, error)

Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.

type CreateBillOfMaterialsImportJobInput

type CreateBillOfMaterialsImportJobInput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The S3 URI of the CSV file to be imported. The bucket must grant permissions
	// for AWS Supply Chain to read the file.
	//
	// This member is required.
	S3uri *string

	// An idempotency token ensures the API request is only completed no more than
	// once. This way, retrying the request will not trigger the operation multiple
	// times. A client token is a unique, case-sensitive string of 33 to 128 ASCII
	// characters. To make an idempotent API request, specify a client token in the
	// request. You should not reuse the same client token for other requests. If you
	// retry a successful request with the same client token, the request will succeed
	// with no further actions being taken, and you will receive the same API response
	// as the original successful request.
	ClientToken *string
	// contains filtered or unexported fields
}

The request parameters for CreateBillOfMaterialsImportJob.

type CreateBillOfMaterialsImportJobOutput

type CreateBillOfMaterialsImportJobOutput struct {

	// The new BillOfMaterialsImportJob identifier.
	//
	// This member is required.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of CreateBillOfMaterialsImportJob.

type CreateDataIntegrationFlowInput added in v1.7.0

type CreateDataIntegrationFlowInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// Name of the DataIntegrationFlow.
	//
	// This member is required.
	Name *string

	// The source configurations for DataIntegrationFlow.
	//
	// This member is required.
	Sources []types.DataIntegrationFlowSource

	// The target configurations for DataIntegrationFlow.
	//
	// This member is required.
	Target *types.DataIntegrationFlowTarget

	// The transformation configurations for DataIntegrationFlow.
	//
	// This member is required.
	Transformation *types.DataIntegrationFlowTransformation

	// The tags of the DataIntegrationFlow to be created
	Tags map[string]string
	// contains filtered or unexported fields
}

The request parameters for CreateDataIntegrationFlow.

type CreateDataIntegrationFlowOutput added in v1.7.0

type CreateDataIntegrationFlowOutput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the DataIntegrationFlow created.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for CreateDataIntegrationFlow.

type CreateDataLakeDatasetInput added in v1.7.0

type CreateDataLakeDatasetInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the dataset. For asc name space, the name must be one of the
	// supported data entities under [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Name *string

	// The name space of the dataset.
	//
	//   - asc - For information on the Amazon Web Services Supply Chain supported
	//   datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	//   - default - For datasets with custom user-defined schemas.
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Namespace *string

	// The description of the dataset.
	Description *string

	// The custom schema of the data lake dataset and is only required when the name
	// space is default.
	Schema *types.DataLakeDatasetSchema

	// The tags of the dataset.
	Tags map[string]string
	// contains filtered or unexported fields
}

The request parameters for CreateDataLakeDataset.

type CreateDataLakeDatasetOutput added in v1.7.0

type CreateDataLakeDatasetOutput struct {

	// The detail of created dataset.
	//
	// This member is required.
	Dataset *types.DataLakeDataset

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of CreateDataLakeDataset.

type CreateInstanceInput added in v1.9.0

type CreateInstanceInput struct {

	// The client token for idempotency.
	ClientToken *string

	// The AWS Supply Chain instance description.
	InstanceDescription *string

	// The AWS Supply Chain instance name.
	InstanceName *string

	// The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you
	// provide for encryption. This is required if you do not want to use the Amazon
	// Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain
	// uses the Amazon Web Services owned KMS key.
	KmsKeyArn *string

	// The Amazon Web Services tags of an instance to be created.
	Tags map[string]string

	// The DNS subdomain of the web app. This would be "example" in the URL
	// "example.scn.global.on.aws". You can set this to a custom value, as long as the
	// domain isn't already being used by someone else. The name may only include
	// alphanumeric characters and hyphens.
	WebAppDnsDomain *string
	// contains filtered or unexported fields
}

The request parameters for CreateInstance.

type CreateInstanceOutput added in v1.9.0

type CreateInstanceOutput struct {

	// The AWS Supply Chain instance resource data details.
	//
	// This member is required.
	Instance *types.Instance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for CreateInstance.

type DeleteDataIntegrationFlowInput added in v1.7.0

type DeleteDataIntegrationFlowInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the DataIntegrationFlow to be deleted.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The request parameters for DeleteDataIntegrationFlow.

type DeleteDataIntegrationFlowOutput added in v1.7.0

type DeleteDataIntegrationFlowOutput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the DataIntegrationFlow deleted.
	//
	// This member is required.
	Name *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for DeleteDataIntegrationFlow.

type DeleteDataLakeDatasetInput added in v1.7.0

type DeleteDataLakeDatasetInput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the dataset. For asc name space, the name must be one of the
	// supported data entities under [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Name *string

	// The name space of the dataset. The available values are:
	//
	//   - asc - For information on the Amazon Web Services Supply Chain supported
	//   datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	//   - default - For datasets with custom user-defined schemas.
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

The request parameters of DeleteDataLakeDataset.

type DeleteDataLakeDatasetOutput added in v1.7.0

type DeleteDataLakeDatasetOutput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of deleted dataset.
	//
	// This member is required.
	Name *string

	// The name space of deleted dataset.
	//
	// This member is required.
	Namespace *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of DeleteDataLakeDataset.

type DeleteInstanceInput added in v1.9.0

type DeleteInstanceInput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

The request parameters for DeleteInstance.

type DeleteInstanceOutput added in v1.9.0

type DeleteInstanceOutput struct {

	// The AWS Supply Chain instance resource data details.
	//
	// This member is required.
	Instance *types.Instance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for DeleteInstance.

type EndpointParameters

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetBillOfMaterialsImportJobInput

type GetBillOfMaterialsImportJobInput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The BillOfMaterialsImportJob identifier.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

The request parameters for GetBillOfMaterialsImportJob.

type GetBillOfMaterialsImportJobOutput

type GetBillOfMaterialsImportJobOutput struct {

	// The BillOfMaterialsImportJob.
	//
	// This member is required.
	Job *types.BillOfMaterialsImportJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for GetBillOfMaterialsImportJob.

type GetDataIntegrationFlowInput added in v1.7.0

type GetDataIntegrationFlowInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the DataIntegrationFlow created.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The request parameters for GetDataIntegrationFlow.

type GetDataIntegrationFlowOutput added in v1.7.0

type GetDataIntegrationFlowOutput struct {

	// The details of the DataIntegrationFlow returned.
	//
	// This member is required.
	Flow *types.DataIntegrationFlow

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for GetDataIntegrationFlow.

type GetDataLakeDatasetInput added in v1.7.0

type GetDataLakeDatasetInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the dataset. For asc name space, the name must be one of the
	// supported data entities under [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Name *string

	// The name space of the dataset. The available values are:
	//
	//   - asc - For information on the Amazon Web Services Supply Chain supported
	//   datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	//   - default - For datasets with custom user-defined schemas.
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Namespace *string
	// contains filtered or unexported fields
}

The request parameters for GetDataLakeDataset.

type GetDataLakeDatasetOutput added in v1.7.0

type GetDataLakeDatasetOutput struct {

	// The fetched dataset details.
	//
	// This member is required.
	Dataset *types.DataLakeDataset

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for UpdateDataLakeDataset.

type GetInstanceInput added in v1.9.0

type GetInstanceInput struct {

	// The AWS Supply Chain instance identifier
	//
	// This member is required.
	InstanceId *string
	// contains filtered or unexported fields
}

The request parameters for GetInstance.

type GetInstanceOutput added in v1.9.0

type GetInstanceOutput struct {

	// The instance resource data details.
	//
	// This member is required.
	Instance *types.Instance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for GetInstance.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListDataIntegrationFlowsAPIClient added in v1.7.0

type ListDataIntegrationFlowsAPIClient interface {
	ListDataIntegrationFlows(context.Context, *ListDataIntegrationFlowsInput, ...func(*Options)) (*ListDataIntegrationFlowsOutput, error)
}

ListDataIntegrationFlowsAPIClient is a client that implements the ListDataIntegrationFlows operation.

type ListDataIntegrationFlowsInput added in v1.7.0

type ListDataIntegrationFlowsInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// Specify the maximum number of DataIntegrationFlows to fetch in one paginated
	// request.
	MaxResults *int32

	// The pagination token to fetch the next page of the DataIntegrationFlows.
	NextToken *string
	// contains filtered or unexported fields
}

The request parameters for ListDataIntegrationFlows.

type ListDataIntegrationFlowsOutput added in v1.7.0

type ListDataIntegrationFlowsOutput struct {

	// The response parameters for ListDataIntegrationFlows.
	//
	// This member is required.
	Flows []types.DataIntegrationFlow

	// The pagination token to fetch the next page of the DataIntegrationFlows.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for ListDataIntegrationFlows.

type ListDataIntegrationFlowsPaginator added in v1.7.0

type ListDataIntegrationFlowsPaginator struct {
	// contains filtered or unexported fields
}

ListDataIntegrationFlowsPaginator is a paginator for ListDataIntegrationFlows

func NewListDataIntegrationFlowsPaginator added in v1.7.0

NewListDataIntegrationFlowsPaginator returns a new ListDataIntegrationFlowsPaginator

func (*ListDataIntegrationFlowsPaginator) HasMorePages added in v1.7.0

func (p *ListDataIntegrationFlowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataIntegrationFlowsPaginator) NextPage added in v1.7.0

NextPage retrieves the next ListDataIntegrationFlows page.

type ListDataIntegrationFlowsPaginatorOptions added in v1.7.0

type ListDataIntegrationFlowsPaginatorOptions struct {
	// Specify the maximum number of DataIntegrationFlows to fetch in one paginated
	// request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataIntegrationFlowsPaginatorOptions is the paginator options for ListDataIntegrationFlows

type ListDataLakeDatasetsAPIClient added in v1.7.0

type ListDataLakeDatasetsAPIClient interface {
	ListDataLakeDatasets(context.Context, *ListDataLakeDatasetsInput, ...func(*Options)) (*ListDataLakeDatasetsOutput, error)
}

ListDataLakeDatasetsAPIClient is a client that implements the ListDataLakeDatasets operation.

type ListDataLakeDatasetsInput added in v1.7.0

type ListDataLakeDatasetsInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name space of the dataset. The available values are:
	//
	//   - asc - For information on the Amazon Web Services Supply Chain supported
	//   datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	//   - default - For datasets with custom user-defined schemas.
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Namespace *string

	// The max number of datasets to fetch in this paginated request.
	MaxResults *int32

	// The pagination token to fetch next page of datasets.
	NextToken *string
	// contains filtered or unexported fields
}

The request parameters of ListDataLakeDatasets.

type ListDataLakeDatasetsOutput added in v1.7.0

type ListDataLakeDatasetsOutput struct {

	// The list of fetched dataset details.
	//
	// This member is required.
	Datasets []types.DataLakeDataset

	// The pagination token to fetch next page of datasets.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of ListDataLakeDatasets.

type ListDataLakeDatasetsPaginator added in v1.7.0

type ListDataLakeDatasetsPaginator struct {
	// contains filtered or unexported fields
}

ListDataLakeDatasetsPaginator is a paginator for ListDataLakeDatasets

func NewListDataLakeDatasetsPaginator added in v1.7.0

NewListDataLakeDatasetsPaginator returns a new ListDataLakeDatasetsPaginator

func (*ListDataLakeDatasetsPaginator) HasMorePages added in v1.7.0

func (p *ListDataLakeDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataLakeDatasetsPaginator) NextPage added in v1.7.0

NextPage retrieves the next ListDataLakeDatasets page.

type ListDataLakeDatasetsPaginatorOptions added in v1.7.0

type ListDataLakeDatasetsPaginatorOptions struct {
	// The max number of datasets to fetch in this paginated request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataLakeDatasetsPaginatorOptions is the paginator options for ListDataLakeDatasets

type ListInstancesAPIClient added in v1.9.0

type ListInstancesAPIClient interface {
	ListInstances(context.Context, *ListInstancesInput, ...func(*Options)) (*ListInstancesOutput, error)
}

ListInstancesAPIClient is a client that implements the ListInstances operation.

type ListInstancesInput added in v1.9.0

type ListInstancesInput struct {

	// The filter to ListInstances based on their names.
	InstanceNameFilter []string

	// The filter to ListInstances based on their state.
	InstanceStateFilter []types.InstanceState

	// Specify the maximum number of instances to fetch in this paginated request.
	MaxResults *int32

	// The pagination token to fetch the next page of instances.
	NextToken *string
	// contains filtered or unexported fields
}

The request parameters for ListInstances.

type ListInstancesOutput added in v1.9.0

type ListInstancesOutput struct {

	// The list of instances resource data details.
	//
	// This member is required.
	Instances []types.Instance

	// The pagination token to fetch the next page of instances.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for ListInstances.

type ListInstancesPaginator added in v1.9.0

type ListInstancesPaginator struct {
	// contains filtered or unexported fields
}

ListInstancesPaginator is a paginator for ListInstances

func NewListInstancesPaginator added in v1.9.0

func NewListInstancesPaginator(client ListInstancesAPIClient, params *ListInstancesInput, optFns ...func(*ListInstancesPaginatorOptions)) *ListInstancesPaginator

NewListInstancesPaginator returns a new ListInstancesPaginator

func (*ListInstancesPaginator) HasMorePages added in v1.9.0

func (p *ListInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInstancesPaginator) NextPage added in v1.9.0

func (p *ListInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInstancesOutput, error)

NextPage retrieves the next ListInstances page.

type ListInstancesPaginatorOptions added in v1.9.0

type ListInstancesPaginatorOptions struct {
	// Specify the maximum number of instances to fetch in this paginated request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListInstancesPaginatorOptions is the paginator options for ListInstances

type ListTagsForResourceInput added in v1.7.0

type ListTagsForResourceInput struct {

	// The Amazon Web Services Supply chain resource ARN that needs tags to be listed.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

The request parameters of ListTagsForResource.

type ListTagsForResourceOutput added in v1.7.0

type ListTagsForResourceOutput struct {

	// The tags added to an Amazon Web Services Supply Chain resource.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of ListTagsForResource.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SendDataIntegrationEventInput added in v1.3.0

type SendDataIntegrationEventInput struct {

	// The data payload of the event. For more information on the data schema to use,
	// see [Data entities supported in AWS Supply Chain].
	//
	// [Data entities supported in AWS Supply Chain]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Data *string

	// Event identifier (for example, orderId for InboundOrder) used for data sharing
	// or partitioning.
	//
	// This member is required.
	EventGroupId *string

	// The data event type.
	//
	// This member is required.
	EventType types.DataIntegrationEventType

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The idempotent client token.
	ClientToken *string

	// The event timestamp (in epoch seconds).
	EventTimestamp *time.Time
	// contains filtered or unexported fields
}

The request parameters for SendDataIntegrationEvent.

type SendDataIntegrationEventOutput added in v1.3.0

type SendDataIntegrationEventOutput struct {

	// The unique event identifier.
	//
	// This member is required.
	EventId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for SendDataIntegrationEvent.

type TagResourceInput added in v1.7.0

type TagResourceInput struct {

	// The Amazon Web Services Supply chain resource ARN that needs to be tagged.
	//
	// This member is required.
	ResourceArn *string

	// The tags of the Amazon Web Services Supply chain resource to be created.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

The request parameters of TagResource.

type TagResourceOutput added in v1.7.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for TagResource.

type UntagResourceInput added in v1.7.0

type UntagResourceInput struct {

	// The Amazon Web Services Supply chain resource ARN that needs to be untagged.
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to be deleted for an Amazon Web Services Supply Chain
	// resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

The request parameters of UntagResource.

type UntagResourceOutput added in v1.7.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of UntagResource.

type UpdateDataIntegrationFlowInput added in v1.7.0

type UpdateDataIntegrationFlowInput struct {

	// The Amazon Web Services Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the DataIntegrationFlow to be updated.
	//
	// This member is required.
	Name *string

	// The new source configurations for the DataIntegrationFlow.
	Sources []types.DataIntegrationFlowSource

	// The new target configurations for the DataIntegrationFlow.
	Target *types.DataIntegrationFlowTarget

	// The new transformation configurations for the DataIntegrationFlow.
	Transformation *types.DataIntegrationFlowTransformation
	// contains filtered or unexported fields
}

The request parameters for UpdateDataIntegrationFlow.

type UpdateDataIntegrationFlowOutput added in v1.7.0

type UpdateDataIntegrationFlowOutput struct {

	// The details of the updated DataIntegrationFlow.
	//
	// This member is required.
	Flow *types.DataIntegrationFlow

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for UpdateDataIntegrationFlow.

type UpdateDataLakeDatasetInput added in v1.7.0

type UpdateDataLakeDatasetInput struct {

	// The Amazon Web Services Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The name of the dataset. For asc name space, the name must be one of the
	// supported data entities under [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Name *string

	// The name space of the dataset. The available values are:
	//
	//   - asc - For information on the Amazon Web Services Supply Chain supported
	//   datasets see [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html].
	//
	//   - default - For datasets with custom user-defined schemas.
	//
	// [https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html]: https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html
	//
	// This member is required.
	Namespace *string

	// The updated description of the data lake dataset.
	Description *string
	// contains filtered or unexported fields
}

The request parameters of UpdateDataLakeDataset.

type UpdateDataLakeDatasetOutput added in v1.7.0

type UpdateDataLakeDatasetOutput struct {

	// The updated dataset details.
	//
	// This member is required.
	Dataset *types.DataLakeDataset

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters of UpdateDataLakeDataset.

type UpdateInstanceInput added in v1.9.0

type UpdateInstanceInput struct {

	// The AWS Supply Chain instance identifier.
	//
	// This member is required.
	InstanceId *string

	// The AWS Supply Chain instance description.
	InstanceDescription *string

	// The AWS Supply Chain instance name.
	InstanceName *string
	// contains filtered or unexported fields
}

The request parameters for UpdateInstance.

type UpdateInstanceOutput added in v1.9.0

type UpdateInstanceOutput struct {

	// The instance resource data details.
	//
	// This member is required.
	Instance *types.Instance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The response parameters for UpdateInstance.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL