elementalinference

type AssociateFeedInput struct {

	// An identifier for the resource. This name must not resemble an ARN.
	//
	// The resource is the source media that the feed will process. The name you
	// assign should help you to later identify the source media that belongs to the
	// feed. In this way, you will know which source media to push to the feed (using
	// PutMedia).
	//
	// This member is required.
	AssociatedResourceName *string

	// The ID of the feed.
	//
	// This member is required.
	Id *string

	// An array of one or more outputs that you want to add to this feed now, to
	// supplement any outputs that you specified when you created or updated the feed.
	//
	// This member is required.
	Outputs []types.CreateOutput

	// Set to true if you want to do a dry run of the associate action.
	//
	// Elemental Inference will validate that the real request would succeed without
	// actually making any changes. A dry run catches errors such as missing IAM
	// permissions, quota limits exceeded, conflicting outputs, and so on. If the dry
	// run fails, the action returns a 4xx error code. After you've fixed the errors,
	// resubmit the request.
	DryRun bool
	// contains filtered or unexported fields
}

type AssociateFeedOutput struct {

	// The ARN of the feed.
	//
	// This member is required.
	Arn *string

	// The ID of the feed.
	//
	// This member is required.
	Id *string

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

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

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

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

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

type CreateDictionaryInput struct {

	// The language of the dictionary entries. Specify the language using an ISO
	// 639-2/T three-letter code. Supported values: eng, fra, ita, deu, spa, por.
	//
	// This member is required.
	Language types.DictionaryLanguage

	// A user-friendly name for this dictionary.
	//
	// This member is required.
	Name *string

	// The dictionary entries payload. Contains the custom words and phrases for the
	// dictionary. Maximum size is 40,960 characters.
	Entries *string

	// Optional tags to associate with the dictionary.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDictionaryOutput struct {

	// The ARN of the dictionary.
	//
	// This member is required.
	Arn *string

	// A unique ID that Elemental Inference assigns to the dictionary.
	//
	// This member is required.
	Id *string

	// The language of the dictionary.
	//
	// This member is required.
	Language types.DictionaryLanguage

	// The name that you specified in the request.
	//
	// This member is required.
	Name *string

	// The current status of the dictionary. After creation succeeds, the status will
	// be AVAILABLE.
	//
	// This member is required.
	Status types.DictionaryStatus

	// A list of feed IDs that reference this dictionary.
	References []string

	// Any tags that you included when you created the dictionary.
	Tags map[string]string

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

type CreateFeedInput struct {

	// A user-friendly name for this feed.
	//
	// This member is required.
	Name *string

	// An array of outputs for this feed. Each output represents a specific Elemental
	// Inference feature. For example, there is one output type for the smart crop
	// feature. You must specify at least one output, but you can later add outputs
	// using AssociateFeed, or add, modify, and delete outputs using UpdateFeed.
	//
	// This member is required.
	Outputs []types.CreateOutput

	// Optional tags. You can also add tags later, using TagResource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFeedOutput struct {

	// A unique ARN that Elemental Inference assigns to the feed.
	//
	// This member is required.
	Arn *string

	// An array of endpoints for the feed. Typically, there is only one endpoint. The
	// feed receives source media at this endpoint (when the calling application calls
	// PutMedia) and returns the resulting metadata to this endpoint (when the calling
	// application calls GetMetadata).
	//
	// This member is required.
	DataEndpoints []string

	// A unique ID that Elemental Inference assigns to the feed.
	//
	// This member is required.
	Id *string

	// The name that you specified in the request.
	//
	// This member is required.
	Name *string

	// Repeats the outputs that you specified in the request.
	//
	// This member is required.
	Outputs []types.GetOutput

	// The current status of the feed. After creation of the feed has succeeded, the
	// status will be AVAILABLE.
	//
	// This member is required.
	Status types.FeedStatus

	// The association for this feed. When you create the feed, this property is
	// empty. You must associate a resource with the feed using AssociateFeed or
	// UpdateFeed.
	Association *types.FeedAssociation

	// Any tags that you included when you created the feed.
	Tags map[string]string

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

type DeleteDictionaryInput struct {

	// The ID of the dictionary to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteDictionaryOutput struct {

	// The ARN of the deleted dictionary.
	//
	// This member is required.
	Arn *string

	// The ID of the deleted dictionary.
	//
	// This member is required.
	Id *string

	// The status of the dictionary after deletion.
	//
	// This member is required.
	Status types.DictionaryStatus

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

type DeleteFeedInput struct {

	// The ID of the feed.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteFeedOutput struct {

	// The ARN of the deleted feed.
	//
	// This member is required.
	Arn *string

	// The ID of the deleted feed.
	//
	// This member is required.
	Id *string

	// The current status of the feed. When deletion of the feed has succeeded, the
	// status will be DELETED.
	//
	// This member is required.
	Status types.FeedStatus

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

type DisassociateFeedInput struct {

	// The name of the resource currently associated with the feed.
	//
	// This member is required.
	AssociatedResourceName *string

	// The ID of the feed where you want to release the resource.
	//
	// This member is required.
	Id *string

	// Set to true if you want to do a dry run of the disassociate action.
	//
	// Elemental Inference will validate that the real request would succeed without
	// actually making any changes. A dry run catches errors such as missing IAM
	// permissions. If the dry run fails, the action returns a 4xx error code.
	DryRun bool
	// contains filtered or unexported fields
}

type DisassociateFeedOutput struct {

	// The ARN of the feed.
	//
	// This member is required.
	Arn *string

	// The ID of the feed.
	//
	// This member is required.
	Id *string

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

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
}

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

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

type EndpointResolverOptions = internalendpoints.Options

type EndpointResolverV2 interface {
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

type ExportDictionaryEntriesInput struct {

	// The ID of the dictionary whose entries you want to export.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type ExportDictionaryEntriesOutput struct {

	// The dictionary entries payload.
	Entries *string

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

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

type FeedDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// FeedDeletedWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, FeedDeletedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetFeedInput, *GetFeedOutput, error) (bool, error)
}

type GetDictionaryInput struct {

	// The ID of the dictionary to retrieve.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetDictionaryOutput struct {

	// The ARN of the dictionary.
	//
	// This member is required.
	Arn *string

	// The ID of the dictionary.
	//
	// This member is required.
	Id *string

	// The language of the dictionary.
	//
	// This member is required.
	Language types.DictionaryLanguage

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

	// The current status of the dictionary.
	//
	// This member is required.
	Status types.DictionaryStatus

	// A list of feed IDs that reference this dictionary.
	References []string

	// The tags associated with the dictionary.
	Tags map[string]string

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

type GetFeedAPIClient interface {
	GetFeed(context.Context, *GetFeedInput, ...func(*Options)) (*GetFeedOutput, error)
}

type GetFeedInput struct {

	// The ID of the feed to query.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetFeedOutput struct {

	// The ARN of the feed.
	//
	// This member is required.
	Arn *string

	// The dataEndpoints of the feed.
	//
	// This member is required.
	DataEndpoints []string

	// The ID of the feed.
	//
	// This member is required.
	Id *string

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

	// An array of the outputs in the feed.
	//
	// This member is required.
	Outputs []types.GetOutput

	// The status of the feed.
	//
	// This member is required.
	Status types.FeedStatus

	// Information about the resource that is associated with the feed. It's possible
	// that there is no associated resource. This is not an error.
	Association *types.FeedAssociation

	// A list of the tags, if any, for the feed.
	Tags map[string]string

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

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

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 interface {
	GetIdempotencyToken() (string, error)
}

type ListDictionariesAPIClient interface {
	ListDictionaries(context.Context, *ListDictionariesInput, ...func(*Options)) (*ListDictionariesOutput, error)
}

type ListDictionariesInput struct {

	// The maximum number of results to return per API request. Valid range: 1 to 100.
	MaxResults *int32

	// The token that identifies the next batch of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDictionariesOutput struct {

	// A list of DictionarySummary objects.
	//
	// This member is required.
	Dictionaries []types.DictionarySummary

	// The token to use to retrieve the next batch of results.
	NextToken *string

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

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

type ListDictionariesPaginatorOptions struct {
	// The maximum number of results to return per API request. Valid range: 1 to 100.
	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
}

type ListFeedsAPIClient interface {
	ListFeeds(context.Context, *ListFeedsInput, ...func(*Options)) (*ListFeedsOutput, error)
}

type ListFeedsInput struct {

	// The maximum number of results to return per API request.
	//
	// For example, you submit a list request with MaxResults set at 5. Although 20
	// items match your request, the service returns no more than the first 5 items.
	// (The service also returns a NextToken value that you can use to fetch the next
	// batch of results.)
	//
	// The service might return fewer results than the MaxResults value. If MaxResults
	// is not included in the request, the service defaults to pagination with a
	// maximum of 10 results per page.
	//
	// Valid Range: Minimum value of 1. Maximum value of 1000.
	MaxResults *int32

	// The token that identifies the batch of results that you want to see.
	//
	// For example, you submit a ListFeeds request with MaxResults set at 5. The
	// service returns the first batch of results (up to 5) and a NextToken value. To
	// see the next batch of results, you can submit the ListFeeds request a second
	// time and specify the NextToken value.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFeedsOutput struct {

	// A list of FeedSummary objects.
	//
	// This member is required.
	Feeds []types.FeedSummary

	// The token that identifies the batch of results that you want to see. For
	// example, you submit a list request with MaxResults set at 5. The service returns
	// the first batch of results (up to 5) and a NextToken value. To see the next
	// batch of results, you can submit the list request a second time and specify the
	// NextToken value.
	NextToken *string

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

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

type ListFeedsPaginatorOptions struct {
	// The maximum number of results to return per API request.
	//
	// For example, you submit a list request with MaxResults set at 5. Although 20
	// items match your request, the service returns no more than the first 5 items.
	// (The service also returns a NextToken value that you can use to fetch the next
	// batch of results.)
	//
	// The service might return fewer results than the MaxResults value. If MaxResults
	// is not included in the request, the service defaults to pagination with a
	// maximum of 10 results per page.
	//
	// Valid Range: Minimum value of 1. Maximum value of 1000.
	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
}

type ListTagsForResourceInput struct {

	// The ARN of the resource whose tags you want to query.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput struct {

	// A list of the tags that belong to this resource.
	Tags map[string]string

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

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

	// Disables SDK clock skew correction. When set, the SDK will not adjust request
	// signing timestamps to compensate for clock drift between the client and the
	// service.
	DisableClockSkewCorrection bool

	// 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.
	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

	// Client registry of operation interceptors.
	Interceptors smithyhttp.InterceptorRegistry

	// 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

	// Priority list of preferred auth scheme names (e.g. sigv4a).
	AuthSchemePreference []string
	// contains filtered or unexported fields
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

type TagResourceInput struct {

	// The ARN of the resource where you want to add tags.
	//
	// This member is required.
	ResourceArn *string

	// A list of tags to add to the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type UntagResourceInput struct {

	// The ARN of the resource where you want to delete one or more tags.
	//
	// This member is required.
	ResourceArn *string

	// The keys of the tags to delete.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

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

type UpdateDictionaryInput struct {

	// The ID of the dictionary to update.
	//
	// This member is required.
	Id *string

	// New dictionary entries. If not specified, the entries are not changed.
	Entries *string

	// A new language for the dictionary. If not specified, the language is not
	// changed.
	Language types.DictionaryLanguage

	// A new name for the dictionary. If not specified, the name is not changed.
	Name *string
	// contains filtered or unexported fields
}

type UpdateDictionaryOutput struct {

	// The ARN of the dictionary.
	//
	// This member is required.
	Arn *string

	// The ID of the dictionary.
	//
	// This member is required.
	Id *string

	// The updated or original language of the dictionary.
	//
	// This member is required.
	Language types.DictionaryLanguage

	// The updated or original name of the dictionary.
	//
	// This member is required.
	Name *string

	// The current status of the dictionary.
	//
	// This member is required.
	Status types.DictionaryStatus

	// A list of feed IDs that reference this dictionary.
	References []string

	// Any tags associated with the dictionary.
	Tags map[string]string

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

type UpdateFeedInput struct {

	// The ID of the feed to update.
	//
	// This member is required.
	Id *string

	// Required. You can specify the existing name (to leave it unchanged) or a new
	// name.
	//
	// This member is required.
	Name *string

	// Required. You can specify the existing array of outputs (to leave outputs
	// unchanged) or you can specify a new array.
	//
	// This member is required.
	Outputs []types.UpdateOutput
	// contains filtered or unexported fields
}

type UpdateFeedOutput struct {

	// The ARN of the feed.
	//
	// This member is required.
	Arn *string

	// The data endpoints of the feed.
	//
	// This member is required.
	DataEndpoints []string

	// The ID of the feed.
	//
	// This member is required.
	Id *string

	// The updated or original name of the feed.
	//
	// This member is required.
	Name *string

	// The array of outputs in the feed. You might have left this array unchanged, or
	// you might have changed it.
	//
	// This member is required.
	Outputs []types.GetOutput

	// The status of the feed.
	//
	// This member is required.
	Status types.FeedStatus

	// Information about the resource that is associated with the feed, if any.
	Association *types.FeedAssociation

	// The tags associated with the feed.
	Tags map[string]string

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