appflow

package module
v1.42.0 Latest Latest
Warning

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

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 43 Imported by: 12

Documentation

Overview

Package appflow provides the API client, operations, and parameter types for Amazon Appflow.

Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors.

Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

Use the following links to get started on the Amazon AppFlow API:

Actions

  • : An alphabetical list of all Amazon AppFlow API operations.

Data types

  • : An alphabetical list of all Amazon AppFlow data types.

Common parameters

  • : Parameters that all Query operations can use.

Common errors

  • : Client and server errors that all operations can return.

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi ) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuthdocumentation.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-08-23"
View Source 
const ServiceID = "Appflow"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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 added in v1.33.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.38.2 

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 added in v1.38.2 

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 added in v1.38.2 

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 added in v1.38.2 

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

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

type CancelFlowExecutionsInput added in v1.29.0 

type CancelFlowExecutionsInput struct {

	// The name of a flow with active runs that you want to cancel.
	//
	// This member is required.
	FlowName *string

	// The ID of each active run to cancel. These runs must belong to the flow you
	// specify in your request.
	//
	// If you omit this parameter, your request ends all active runs that belong to
	// the flow.
	ExecutionIds []string
	// contains filtered or unexported fields
}

type CancelFlowExecutionsOutput added in v1.29.0 

type CancelFlowExecutionsOutput struct {

	// The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be
	// ineligible for canceling because they haven't started yet or have already
	// completed.
	InvalidExecutions []string

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

type Client 

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

Client provides the API client to make operations call for Amazon Appflow.

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) CancelFlowExecutions added in v1.29.0 

func (c *Client) CancelFlowExecutions(ctx context.Context, params *CancelFlowExecutionsInput, optFns ...func(*Options)) (*CancelFlowExecutionsOutput, error)

Cancels active runs for a flow.

You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.

You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action.

You cannot resume a run after you cancel it.

When you send your request, the status for each run becomes CancelStarted . When the cancellation completes, the status becomes Canceled .

When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.

func (*Client) CreateConnectorProfile 

func (c *Client) CreateConnectorProfile(ctx context.Context, params *CreateConnectorProfileInput, optFns ...func(*Options)) (*CreateConnectorProfileOutput, error)
Creates a new connector profile associated with your Amazon Web Services

account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

func (*Client) CreateFlow 

func (c *Client) CreateFlow(ctx context.Context, params *CreateFlowInput, optFns ...func(*Options)) (*CreateFlowOutput, error)
Enables your application to create a new flow using Amazon AppFlow. You must

create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

func (*Client) DeleteConnectorProfile 

func (c *Client) DeleteConnectorProfile(ctx context.Context, params *DeleteConnectorProfileInput, optFns ...func(*Options)) (*DeleteConnectorProfileOutput, error)

Enables you to delete an existing connector profile.

func (*Client) DeleteFlow 

func (c *Client) DeleteFlow(ctx context.Context, params *DeleteFlowInput, optFns ...func(*Options)) (*DeleteFlowOutput, error)
Enables your application to delete an existing flow. Before deleting the flow,

Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.

func (*Client) DescribeConnector added in v1.13.0 

func (c *Client) DescribeConnector(ctx context.Context, params *DescribeConnectorInput, optFns ...func(*Options)) (*DescribeConnectorOutput, error)

Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

func (*Client) DescribeConnectorEntity 

func (c *Client) DescribeConnectorEntity(ctx context.Context, params *DescribeConnectorEntityInput, optFns ...func(*Options)) (*DescribeConnectorEntityOutput, error)
Provides details regarding the entity used with the connector, with a

description of the data model for each field in that entity.

func (*Client) DescribeConnectorProfiles 

func (c *Client) DescribeConnectorProfiles(ctx context.Context, params *DescribeConnectorProfilesInput, optFns ...func(*Options)) (*DescribeConnectorProfilesOutput, error)
Returns a list of connector-profile details matching the provided

connector-profile names and connector-types . Both input lists are optional, and you can use them to filter the result.

If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

func (*Client) DescribeConnectors 

func (c *Client) DescribeConnectors(ctx context.Context, params *DescribeConnectorsInput, optFns ...func(*Options)) (*DescribeConnectorsOutput, error)
Describes the connectors vended by Amazon AppFlow for specified connector

types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

func (*Client) DescribeFlow 

func (c *Client) DescribeFlow(ctx context.Context, params *DescribeFlowInput, optFns ...func(*Options)) (*DescribeFlowOutput, error)

Provides a description of the specified flow.

func (*Client) DescribeFlowExecutionRecords 

func (c *Client) DescribeFlowExecutionRecords(ctx context.Context, params *DescribeFlowExecutionRecordsInput, optFns ...func(*Options)) (*DescribeFlowExecutionRecordsOutput, error)

Fetches the execution history of the flow.

func (*Client) ListConnectorEntities 

func (c *Client) ListConnectorEntities(ctx context.Context, params *ListConnectorEntitiesInput, optFns ...func(*Options)) (*ListConnectorEntitiesOutput, error)
Returns the list of available connector entities supported by Amazon AppFlow.

For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

func (*Client) ListConnectors added in v1.13.0 

func (c *Client) ListConnectors(ctx context.Context, params *ListConnectorsInput, optFns ...func(*Options)) (*ListConnectorsOutput, error)

Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

func (*Client) ListFlows 

func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns ...func(*Options)) (*ListFlowsOutput, error)

Lists all of the flows associated with your account.

func (*Client) ListTagsForResource 

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

Retrieves the tags that are associated with a specified flow.

func (*Client) Options added in v1.39.0 

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) RegisterConnector added in v1.13.0 

func (c *Client) RegisterConnector(ctx context.Context, params *RegisterConnectorInput, optFns ...func(*Options)) (*RegisterConnectorOutput, error)

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

func (*Client) ResetConnectorMetadataCache added in v1.31.0 

func (c *Client) ResetConnectorMetadataCache(ctx context.Context, params *ResetConnectorMetadataCacheInput, optFns ...func(*Options)) (*ResetConnectorMetadataCacheOutput, error)

Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application.

Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away.

func (*Client) StartFlow 

func (c *Client) StartFlow(ctx context.Context, params *StartFlowInput, optFns ...func(*Options)) (*StartFlowOutput, error)
Activates an existing flow. For on-demand flows, this operation runs the flow

immediately. For schedule and event-triggered flows, this operation activates the flow.

func (*Client) StopFlow 

func (c *Client) StopFlow(ctx context.Context, params *StopFlowInput, optFns ...func(*Options)) (*StopFlowOutput, error)
Deactivates the existing flow. For on-demand flows, this operation returns an

unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

func (*Client) TagResource 

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

Applies a tag to the specified flow.

func (*Client) UnregisterConnector added in v1.13.0 

func (c *Client) UnregisterConnector(ctx context.Context, params *UnregisterConnectorInput, optFns ...func(*Options)) (*UnregisterConnectorOutput, error)

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

func (*Client) UntagResource 

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

Removes a tag from the specified flow.

func (*Client) UpdateConnectorProfile 

func (c *Client) UpdateConnectorProfile(ctx context.Context, params *UpdateConnectorProfileInput, optFns ...func(*Options)) (*UpdateConnectorProfileOutput, error)

Updates a given connector profile associated with your account.

func (*Client) UpdateConnectorRegistration added in v1.20.0 

func (c *Client) UpdateConnectorRegistration(ctx context.Context, params *UpdateConnectorRegistrationInput, optFns ...func(*Options)) (*UpdateConnectorRegistrationOutput, error)

Updates a custom connector that you've previously registered. This operation updates the connector with one of the following:

  • The latest version of the AWS Lambda function that's assigned to the connector

  • A new AWS Lambda function that you specify

func (*Client) UpdateFlow 

func (c *Client) UpdateFlow(ctx context.Context, params *UpdateFlowInput, optFns ...func(*Options)) (*UpdateFlowOutput, error)

Updates an existing flow.

type CreateConnectorProfileInput 

type CreateConnectorProfileInput struct {

	//  Indicates the connection mode and specifies whether it is public or private.
	// Private flows use Amazon Web Services PrivateLink to route data over Amazon Web
	// Services infrastructure without exposing it to the public internet.
	//
	// This member is required.
	ConnectionMode types.ConnectionMode

	//  Defines the connector-specific configuration and credentials.
	//
	// This member is required.
	ConnectorProfileConfig *types.ConnectorProfileConfig

	//  The name of the connector profile. The name is unique for each ConnectorProfile
	// in your Amazon Web Services account.
	//
	// This member is required.
	ConnectorProfileName *string

	//  The type of connector, such as Salesforce, Amplitude, and so on.
	//
	// This member is required.
	ConnectorType types.ConnectorType

	// The clientToken parameter is an idempotency token. It ensures that your
	// CreateConnectorProfile request completes only once. You choose the value to
	// pass. For example, if you don't receive a response from your request, you can
	// safely retry the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to CreateConnectorProfile . The token is active for 8 hours.
	ClientToken *string

	// The label of the connector. The label is unique for each ConnectorRegistration
	// in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR
	// connector type/.
	ConnectorLabel *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
	// AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses
	// the Amazon AppFlow-managed KMS key.
	KmsArn *string
	// contains filtered or unexported fields
}

type CreateConnectorProfileOutput 

type CreateConnectorProfileOutput struct {

	//  The Amazon Resource Name (ARN) of the connector profile.
	ConnectorProfileArn *string

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

type CreateFlowInput 

type CreateFlowInput struct {

	//  The configuration that controls how Amazon AppFlow places data in the
	// destination connector.
	//
	// This member is required.
	DestinationFlowConfigList []types.DestinationFlowConfig

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string

	//  The configuration that controls how Amazon AppFlow retrieves data from the
	// source connector.
	//
	// This member is required.
	SourceFlowConfig *types.SourceFlowConfig

	//  A list of tasks that Amazon AppFlow performs while transferring the data in
	// the flow run.
	//
	// This member is required.
	Tasks []types.Task

	//  The trigger settings that determine how and when the flow runs.
	//
	// This member is required.
	TriggerConfig *types.TriggerConfig

	// The clientToken parameter is an idempotency token. It ensures that your
	// CreateFlow request completes only once. You choose the value to pass. For
	// example, if you don't receive a response from your request, you can safely retry
	// the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to CreateFlow . The token is active for 8 hours.
	ClientToken *string

	//  A description of the flow you want to create.
	Description *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
	// AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses
	// the Amazon AppFlow-managed KMS key.
	KmsArn *string

	// Specifies the configuration that Amazon AppFlow uses when it catalogs the data
	// that's transferred by the associated flow. When Amazon AppFlow catalogs the data
	// from a flow, it stores metadata in a data catalog.
	MetadataCatalogConfig *types.MetadataCatalogConfig

	//  The tags used to organize, track, or control access for your flow.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFlowOutput 

type CreateFlowOutput struct {

	//  The flow's Amazon Resource Name (ARN).
	FlowArn *string

	//  Indicates the current status of the flow.
	FlowStatus types.FlowStatus

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

type DeleteConnectorProfileInput 

type DeleteConnectorProfileInput struct {

	//  The name of the connector profile. The name is unique for each ConnectorProfile
	// in your account.
	//
	// This member is required.
	ConnectorProfileName *string

	//  Indicates whether Amazon AppFlow should delete the profile, even if it is
	// currently in use in one or more flows.
	ForceDelete bool
	// contains filtered or unexported fields
}

type DeleteConnectorProfileOutput 

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

type DeleteFlowInput 

type DeleteFlowInput struct {

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string

	//  Indicates whether Amazon AppFlow should delete the flow, even if it is
	// currently in use.
	ForceDelete bool
	// contains filtered or unexported fields
}

type DeleteFlowOutput 

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

type DescribeConnectorEntityInput 

type DescribeConnectorEntityInput struct {

	//  The entity name for that connector.
	//
	// This member is required.
	ConnectorEntityName *string

	// The version of the API that's used by the connector.
	ApiVersion *string

	//  The name of the connector profile. The name is unique for each ConnectorProfile
	// in the Amazon Web Services account.
	ConnectorProfileName *string

	//  The type of connector application, such as Salesforce, Amplitude, and so on.
	ConnectorType types.ConnectorType
	// contains filtered or unexported fields
}

type DescribeConnectorEntityOutput 

type DescribeConnectorEntityOutput struct {

	//  Describes the fields for that connector entity. For example, for an account
	// entity, the fields would be account name, account ID, and so on.
	//
	// This member is required.
	ConnectorEntityFields []types.ConnectorEntityField

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

type DescribeConnectorInput added in v1.13.0 

type DescribeConnectorInput struct {

	// The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose
	// CUSTOMCONNECTOR for Lambda based custom connectors.
	//
	// This member is required.
	ConnectorType types.ConnectorType

	// The label of the connector. The label is unique for each ConnectorRegistration
	// in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR
	// connector type/.
	ConnectorLabel *string
	// contains filtered or unexported fields
}

type DescribeConnectorOutput added in v1.13.0 

type DescribeConnectorOutput struct {

	// Configuration info of all the connectors that the user requested.
	ConnectorConfiguration *types.ConnectorConfiguration

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

type DescribeConnectorProfilesAPIClient added in v0.2.0 

type DescribeConnectorProfilesAPIClient interface {
	DescribeConnectorProfiles(context.Context, *DescribeConnectorProfilesInput, ...func(*Options)) (*DescribeConnectorProfilesOutput, error)
}

DescribeConnectorProfilesAPIClient is a client that implements the DescribeConnectorProfiles operation.

type DescribeConnectorProfilesInput 

type DescribeConnectorProfilesInput struct {

	// The name of the connector. The name is unique for each ConnectorRegistration in
	// your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR
	// connector type/.
	ConnectorLabel *string

	//  The name of the connector profile. The name is unique for each ConnectorProfile
	// in the Amazon Web Services account.
	ConnectorProfileNames []string

	//  The type of connector, such as Salesforce, Amplitude, and so on.
	ConnectorType types.ConnectorType

	//  Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	MaxResults *int32

	//  The pagination token for the next page of data.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeConnectorProfilesOutput 

type DescribeConnectorProfilesOutput struct {

	//  Returns information about the connector profiles associated with the flow.
	ConnectorProfileDetails []types.ConnectorProfile

	//  The pagination token for the next page of data. If nextToken=null , this means
	// that all records have been fetched.
	NextToken *string

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

type DescribeConnectorProfilesPaginator added in v0.2.0 

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

DescribeConnectorProfilesPaginator is a paginator for DescribeConnectorProfiles

func NewDescribeConnectorProfilesPaginator added in v0.2.0 

func NewDescribeConnectorProfilesPaginator(client DescribeConnectorProfilesAPIClient, params *DescribeConnectorProfilesInput, optFns ...func(*DescribeConnectorProfilesPaginatorOptions)) *DescribeConnectorProfilesPaginator

NewDescribeConnectorProfilesPaginator returns a new DescribeConnectorProfilesPaginator

func (*DescribeConnectorProfilesPaginator) HasMorePages added in v0.2.0 

func (p *DescribeConnectorProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeConnectorProfilesPaginator) NextPage added in v0.2.0 

func (p *DescribeConnectorProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeConnectorProfilesOutput, error)

NextPage retrieves the next DescribeConnectorProfiles page.

type DescribeConnectorProfilesPaginatorOptions added in v0.2.0 

type DescribeConnectorProfilesPaginatorOptions struct {
	//  Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	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
}

DescribeConnectorProfilesPaginatorOptions is the paginator options for DescribeConnectorProfiles

type DescribeConnectorsAPIClient added in v0.2.0 

type DescribeConnectorsAPIClient interface {
	DescribeConnectors(context.Context, *DescribeConnectorsInput, ...func(*Options)) (*DescribeConnectorsOutput, error)
}

DescribeConnectorsAPIClient is a client that implements the DescribeConnectors operation.

type DescribeConnectorsInput 

type DescribeConnectorsInput struct {

	//  The type of connector, such as Salesforce, Amplitude, and so on.
	ConnectorTypes []types.ConnectorType

	// The maximum number of items that should be returned in the result set. The
	// default is 20.
	MaxResults *int32

	//  The pagination token for the next page of data.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeConnectorsOutput 

type DescribeConnectorsOutput struct {

	//  The configuration that is applied to the connectors used in the flow.
	ConnectorConfigurations map[string]types.ConnectorConfiguration

	// Information about the connectors supported in Amazon AppFlow.
	Connectors []types.ConnectorDetail

	//  The pagination token for the next page of data.
	NextToken *string

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

type DescribeConnectorsPaginator added in v0.2.0 

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

DescribeConnectorsPaginator is a paginator for DescribeConnectors

func NewDescribeConnectorsPaginator added in v0.2.0 

func NewDescribeConnectorsPaginator(client DescribeConnectorsAPIClient, params *DescribeConnectorsInput, optFns ...func(*DescribeConnectorsPaginatorOptions)) *DescribeConnectorsPaginator

NewDescribeConnectorsPaginator returns a new DescribeConnectorsPaginator

func (*DescribeConnectorsPaginator) HasMorePages added in v0.2.0 

func (p *DescribeConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeConnectorsPaginator) NextPage added in v0.2.0 

func (p *DescribeConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeConnectorsOutput, error)

NextPage retrieves the next DescribeConnectors page.

type DescribeConnectorsPaginatorOptions added in v0.2.0 

type DescribeConnectorsPaginatorOptions struct {
	// The maximum number of items that should be returned in the result set. The
	// default is 20.
	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
}

DescribeConnectorsPaginatorOptions is the paginator options for DescribeConnectors

type DescribeFlowExecutionRecordsAPIClient added in v0.2.0 

type DescribeFlowExecutionRecordsAPIClient interface {
	DescribeFlowExecutionRecords(context.Context, *DescribeFlowExecutionRecordsInput, ...func(*Options)) (*DescribeFlowExecutionRecordsOutput, error)
}

DescribeFlowExecutionRecordsAPIClient is a client that implements the DescribeFlowExecutionRecords operation.

type DescribeFlowExecutionRecordsInput 

type DescribeFlowExecutionRecordsInput struct {

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string

	//  Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	MaxResults *int32

	//  The pagination token for the next page of data.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeFlowExecutionRecordsOutput 

type DescribeFlowExecutionRecordsOutput struct {

	//  Returns a list of all instances when this flow was run.
	FlowExecutions []types.ExecutionRecord

	//  The pagination token for the next page of data.
	NextToken *string

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

type DescribeFlowExecutionRecordsPaginator added in v0.2.0 

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

DescribeFlowExecutionRecordsPaginator is a paginator for DescribeFlowExecutionRecords

func NewDescribeFlowExecutionRecordsPaginator added in v0.2.0 

func NewDescribeFlowExecutionRecordsPaginator(client DescribeFlowExecutionRecordsAPIClient, params *DescribeFlowExecutionRecordsInput, optFns ...func(*DescribeFlowExecutionRecordsPaginatorOptions)) *DescribeFlowExecutionRecordsPaginator

NewDescribeFlowExecutionRecordsPaginator returns a new DescribeFlowExecutionRecordsPaginator

func (*DescribeFlowExecutionRecordsPaginator) HasMorePages added in v0.2.0 

func (p *DescribeFlowExecutionRecordsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeFlowExecutionRecordsPaginator) NextPage added in v0.2.0 

func (p *DescribeFlowExecutionRecordsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFlowExecutionRecordsOutput, error)

NextPage retrieves the next DescribeFlowExecutionRecords page.

type DescribeFlowExecutionRecordsPaginatorOptions added in v0.2.0 

type DescribeFlowExecutionRecordsPaginatorOptions struct {
	//  Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	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
}

DescribeFlowExecutionRecordsPaginatorOptions is the paginator options for DescribeFlowExecutionRecords

type DescribeFlowInput 

type DescribeFlowInput struct {

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string
	// contains filtered or unexported fields
}

type DescribeFlowOutput 

type DescribeFlowOutput struct {

	//  Specifies when the flow was created.
	CreatedAt *time.Time

	//  The ARN of the user who created the flow.
	CreatedBy *string

	//  A description of the flow.
	Description *string

	//  The configuration that controls how Amazon AppFlow transfers data to the
	// destination connector.
	DestinationFlowConfigList []types.DestinationFlowConfig

	//  The flow's Amazon Resource Name (ARN).
	FlowArn *string

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	FlowName *string

	//  Indicates the current status of the flow.
	FlowStatus types.FlowStatus

	//  Contains an error message if the flow status is in a suspended or error state.
	// This applies only to scheduled or event-triggered flows.
	FlowStatusMessage *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
	// AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses
	// the Amazon AppFlow-managed KMS key.
	KmsArn *string

	//  Describes the details of the most recent flow run.
	LastRunExecutionDetails *types.ExecutionDetails

	// Describes the metadata catalog, metadata table, and data partitions that Amazon
	// AppFlow used for the associated flow run.
	LastRunMetadataCatalogDetails []types.MetadataCatalogDetail

	//  Specifies when the flow was last updated.
	LastUpdatedAt *time.Time

	//  Specifies the user name of the account that performed the most recent update.
	LastUpdatedBy *string

	// Specifies the configuration that Amazon AppFlow uses when it catalogs the data
	// that's transferred by the associated flow. When Amazon AppFlow catalogs the data
	// from a flow, it stores metadata in a data catalog.
	MetadataCatalogConfig *types.MetadataCatalogConfig

	// The version number of your data schema. Amazon AppFlow assigns this version
	// number. The version number increases by one when you change any of the following
	// settings in your flow configuration:
	//
	//   - Source-to-destination field mappings
	//
	//   - Field data types
	//
	//   - Partition keys
	SchemaVersion *int64

	//  The configuration that controls how Amazon AppFlow retrieves data from the
	// source connector.
	SourceFlowConfig *types.SourceFlowConfig

	//  The tags used to organize, track, or control access for your flow.
	Tags map[string]string

	//  A list of tasks that Amazon AppFlow performs while transferring the data in
	// the flow run.
	Tasks []types.Task

	//  The trigger settings that determine how and when the flow runs.
	TriggerConfig *types.TriggerConfig

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

type EndpointParameters added in v1.33.0 

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 added in v1.33.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.33.0 

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 added in v1.1.0 

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 added in v1.33.0 

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 added in v1.33.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

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 added in v1.26.0 

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

IdempotencyTokenProvider interface for providing idempotency token

type ListConnectorEntitiesInput 

type ListConnectorEntitiesInput struct {

	// The version of the API that's used by the connector.
	ApiVersion *string

	//  The name of the connector profile. The name is unique for each ConnectorProfile
	// in the Amazon Web Services account, and is used to query the downstream
	// connector.
	ConnectorProfileName *string

	//  The type of connector, such as Salesforce, Amplitude, and so on.
	ConnectorType types.ConnectorType

	//  This optional parameter is specific to connector implementation. Some
	// connectors support multiple levels or categories of entities. You can find out
	// the list of roots for such providers by sending a request without the
	// entitiesPath parameter. If the connector supports entities at different roots,
	// this initial request returns the list of roots. Otherwise, this request returns
	// all entities supported by the provider.
	EntitiesPath *string

	// The maximum number of items that the operation returns in the response.
	MaxResults *int32

	// A token that was provided by your prior ListConnectorEntities operation if the
	// response was too big for the page size. You specify this token to get the next
	// page of results in paginated response.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConnectorEntitiesOutput 

type ListConnectorEntitiesOutput struct {

	//  The response of ListConnectorEntities lists entities grouped by category. This
	// map's key represents the group name, and its value contains the list of entities
	// belonging to that group.
	//
	// This member is required.
	ConnectorEntityMap map[string][]types.ConnectorEntity

	// A token that you specify in your next ListConnectorEntities operation to get
	// the next page of results in paginated response. The ListConnectorEntities
	// operation provides this token if the response is too big for the page size.
	NextToken *string

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

type ListConnectorsAPIClient added in v1.13.0 

type ListConnectorsAPIClient interface {
	ListConnectors(context.Context, *ListConnectorsInput, ...func(*Options)) (*ListConnectorsOutput, error)
}

ListConnectorsAPIClient is a client that implements the ListConnectors operation.

type ListConnectorsInput added in v1.13.0 

type ListConnectorsInput struct {

	// Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	MaxResults *int32

	// The pagination token for the next page of data.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConnectorsOutput added in v1.13.0 

type ListConnectorsOutput struct {

	// Contains information about the connectors supported by Amazon AppFlow.
	Connectors []types.ConnectorDetail

	// The pagination token for the next page of data. If nextToken=null, this means
	// that all records have been fetched.
	NextToken *string

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

type ListConnectorsPaginator added in v1.13.0 

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

ListConnectorsPaginator is a paginator for ListConnectors

func NewListConnectorsPaginator added in v1.13.0 

func NewListConnectorsPaginator(client ListConnectorsAPIClient, params *ListConnectorsInput, optFns ...func(*ListConnectorsPaginatorOptions)) *ListConnectorsPaginator

NewListConnectorsPaginator returns a new ListConnectorsPaginator

func (*ListConnectorsPaginator) HasMorePages added in v1.13.0 

func (p *ListConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConnectorsPaginator) NextPage added in v1.13.0 

func (p *ListConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConnectorsOutput, error)

NextPage retrieves the next ListConnectors page.

type ListConnectorsPaginatorOptions added in v1.13.0 

type ListConnectorsPaginatorOptions struct {
	// Specifies the maximum number of items that should be returned in the result
	// set. The default for maxResults is 20 (for all paginated API operations).
	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
}

ListConnectorsPaginatorOptions is the paginator options for ListConnectors

type ListFlowsAPIClient added in v0.2.0 

type ListFlowsAPIClient interface {
	ListFlows(context.Context, *ListFlowsInput, ...func(*Options)) (*ListFlowsOutput, error)
}

ListFlowsAPIClient is a client that implements the ListFlows operation.

type ListFlowsInput 

type ListFlowsInput struct {

	//  Specifies the maximum number of items that should be returned in the result
	// set.
	MaxResults *int32

	//  The pagination token for next page of data.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFlowsOutput 

type ListFlowsOutput struct {

	//  The list of flows associated with your account.
	Flows []types.FlowDefinition

	//  The pagination token for next page of data.
	NextToken *string

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

type ListFlowsPaginator added in v0.2.0 

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

ListFlowsPaginator is a paginator for ListFlows

func NewListFlowsPaginator added in v0.2.0 

func NewListFlowsPaginator(client ListFlowsAPIClient, params *ListFlowsInput, optFns ...func(*ListFlowsPaginatorOptions)) *ListFlowsPaginator

NewListFlowsPaginator returns a new ListFlowsPaginator

func (*ListFlowsPaginator) HasMorePages added in v0.2.0 

func (p *ListFlowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlowsPaginator) NextPage added in v0.2.0 

func (p *ListFlowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlowsOutput, error)

NextPage retrieves the next ListFlows page.

type ListFlowsPaginatorOptions added in v0.2.0 

type ListFlowsPaginatorOptions struct {
	//  Specifies the maximum number of items that should be returned in the result
	// set.
	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
}

ListFlowsPaginatorOptions is the paginator options for ListFlows

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	//  The Amazon Resource Name (ARN) of the specified flow.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	//  The tags used to organize, track, or control access for your flow.
	Tags map[string]string

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

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

	// Indicates how aws account ID is applied in endpoint2.0 routing
	AccountIDEndpointMode aws.AccountIDEndpointMode

	// 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 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 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 added in v1.38.2 

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

type RegisterConnectorInput added in v1.13.0 

type RegisterConnectorInput struct {

	// The clientToken parameter is an idempotency token. It ensures that your
	// RegisterConnector request completes only once. You choose the value to pass. For
	// example, if you don't receive a response from your request, you can safely retry
	// the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to RegisterConnector . The token is active for 8 hours.
	ClientToken *string

	//  The name of the connector. The name is unique for each ConnectorRegistration
	// in your Amazon Web Services account.
	ConnectorLabel *string

	// The provisioning type of the connector. Currently the only supported value is
	// LAMBDA.
	ConnectorProvisioningConfig *types.ConnectorProvisioningConfig

	// The provisioning type of the connector. Currently the only supported value is
	// LAMBDA.
	ConnectorProvisioningType types.ConnectorProvisioningType

	// A description about the connector that's being registered.
	Description *string
	// contains filtered or unexported fields
}

type RegisterConnectorOutput added in v1.13.0 

type RegisterConnectorOutput struct {

	// The ARN of the connector being registered.
	ConnectorArn *string

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

type ResetConnectorMetadataCacheInput added in v1.31.0 

type ResetConnectorMetadataCacheInput struct {

	// The API version that you specified in the connector profile that you’re
	// resetting cached metadata for. You must use this parameter only if the connector
	// supports multiple API versions or if the connector type is CustomConnector.
	//
	// To look up how many versions a connector supports, use the DescribeConnectors
	// action. In the response, find the value that Amazon AppFlow returns for the
	// connectorVersion parameter.
	//
	// To look up the connector type, use the DescribeConnectorProfiles action. In the
	// response, find the value that Amazon AppFlow returns for the connectorType
	// parameter.
	//
	// To look up the API version that you specified in a connector profile, use the
	// DescribeConnectorProfiles action.
	ApiVersion *string

	// Use this parameter if you want to reset cached metadata about the details for
	// an individual entity.
	//
	// If you don't include this parameter in your request, Amazon AppFlow only resets
	// cached metadata about entity names, not entity details.
	ConnectorEntityName *string

	// The name of the connector profile that you want to reset cached metadata for.
	//
	// You can omit this parameter if you're resetting the cache for any of the
	// following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for
	// Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other
	// connector, you must include this parameter in your request.
	ConnectorProfileName *string

	// The type of connector to reset cached metadata for.
	//
	// You must include this parameter in your request if you're resetting the cache
	// for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon
	// Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for
	// any other connector, you can omit this parameter from your request.
	ConnectorType types.ConnectorType

	// Use this parameter only if you’re resetting the cached metadata about a nested
	// entity. Only some connectors support nested entities. A nested entity is one
	// that has another entity as a parent. To use this parameter, specify the name of
	// the parent entity.
	//
	// To look up the parent-child relationship of entities, you can send a
	// ListConnectorEntities request that omits the entitiesPath parameter. Amazon
	// AppFlow will return a list of top-level entities. For each one, it indicates
	// whether the entity has nested entities. Then, in a subsequent
	// ListConnectorEntities request, you can specify a parent entity name for the
	// entitiesPath parameter. Amazon AppFlow will return a list of the child entities
	// for that parent.
	EntitiesPath *string
	// contains filtered or unexported fields
}

type ResetConnectorMetadataCacheOutput added in v1.31.0 

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartFlowInput 

type StartFlowInput struct {

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string

	// The clientToken parameter is an idempotency token. It ensures that your
	// StartFlow request completes only once. You choose the value to pass. For
	// example, if you don't receive a response from your request, you can safely retry
	// the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs for flows that run on a schedule or based on an event. However, the error
	// doesn't occur for flows that run on demand. You set the conditions that initiate
	// your flow for the triggerConfig parameter.
	//
	// If you use a different value for clientToken , Amazon AppFlow considers it a new
	// call to StartFlow . The token is active for 8 hours.
	ClientToken *string
	// contains filtered or unexported fields
}

type StartFlowOutput 

type StartFlowOutput struct {

	//  Returns the internal execution ID of an on-demand flow when the flow is
	// started. For scheduled or event-triggered flows, this value is null.
	ExecutionId *string

	//  The flow's Amazon Resource Name (ARN).
	FlowArn *string

	//  Indicates the current status of the flow.
	FlowStatus types.FlowStatus

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

type StopFlowInput 

type StopFlowInput struct {

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string
	// contains filtered or unexported fields
}

type StopFlowOutput 

type StopFlowOutput struct {

	//  The flow's Amazon Resource Name (ARN).
	FlowArn *string

	//  Indicates the current status of the flow.
	FlowStatus types.FlowStatus

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

type TagResourceInput 

type TagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the flow that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	//  The tags used to organize, track, or control access for your flow.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UnregisterConnectorInput added in v1.13.0 

type UnregisterConnectorInput struct {

	// The label of the connector. The label is unique for each ConnectorRegistration
	// in your Amazon Web Services account.
	//
	// This member is required.
	ConnectorLabel *string

	// Indicates whether Amazon AppFlow should unregister the connector, even if it is
	// currently in use in one or more connector profiles. The default value is false.
	ForceDelete bool
	// contains filtered or unexported fields
}

type UnregisterConnectorOutput added in v1.13.0 

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

type UntagResourceInput 

type UntagResourceInput struct {

	//  The Amazon Resource Name (ARN) of the flow that you want to untag.
	//
	// This member is required.
	ResourceArn *string

	//  The tag keys associated with the tag that you want to remove from your flow.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateConnectorProfileInput 

type UpdateConnectorProfileInput struct {

	//  Indicates the connection mode and if it is public or private.
	//
	// This member is required.
	ConnectionMode types.ConnectionMode

	//  Defines the connector-specific profile configuration and credentials.
	//
	// This member is required.
	ConnectorProfileConfig *types.ConnectorProfileConfig

	//  The name of the connector profile and is unique for each ConnectorProfile in
	// the Amazon Web Services account.
	//
	// This member is required.
	ConnectorProfileName *string

	// The clientToken parameter is an idempotency token. It ensures that your
	// UpdateConnectorProfile request completes only once. You choose the value to
	// pass. For example, if you don't receive a response from your request, you can
	// safely retry the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to UpdateConnectorProfile . The token is active for 8 hours.
	ClientToken *string
	// contains filtered or unexported fields
}

type UpdateConnectorProfileOutput 

type UpdateConnectorProfileOutput struct {

	//  The Amazon Resource Name (ARN) of the connector profile.
	ConnectorProfileArn *string

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

type UpdateConnectorRegistrationInput added in v1.20.0 

type UpdateConnectorRegistrationInput struct {

	// The name of the connector. The name is unique for each connector registration
	// in your AWS account.
	//
	// This member is required.
	ConnectorLabel *string

	// The clientToken parameter is an idempotency token. It ensures that your
	// UpdateConnectorRegistration request completes only once. You choose the value to
	// pass. For example, if you don't receive a response from your request, you can
	// safely retry the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to UpdateConnectorRegistration . The token is active for 8 hours.
	ClientToken *string

	// Contains information about the configuration of the connector being registered.
	ConnectorProvisioningConfig *types.ConnectorProvisioningConfig

	// A description about the update that you're applying to the connector.
	Description *string
	// contains filtered or unexported fields
}

type UpdateConnectorRegistrationOutput added in v1.20.0 

type UpdateConnectorRegistrationOutput struct {

	// The ARN of the connector being updated.
	ConnectorArn *string

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

type UpdateFlowInput 

type UpdateFlowInput struct {

	//  The configuration that controls how Amazon AppFlow transfers data to the
	// destination connector.
	//
	// This member is required.
	DestinationFlowConfigList []types.DestinationFlowConfig

	//  The specified name of the flow. Spaces are not allowed. Use underscores (_) or
	// hyphens (-) only.
	//
	// This member is required.
	FlowName *string

	//  Contains information about the configuration of the source connector used in
	// the flow.
	//
	// This member is required.
	SourceFlowConfig *types.SourceFlowConfig

	//  A list of tasks that Amazon AppFlow performs while transferring the data in
	// the flow run.
	//
	// This member is required.
	Tasks []types.Task

	//  The trigger settings that determine how and when the flow runs.
	//
	// This member is required.
	TriggerConfig *types.TriggerConfig

	// The clientToken parameter is an idempotency token. It ensures that your
	// UpdateFlow request completes only once. You choose the value to pass. For
	// example, if you don't receive a response from your request, you can safely retry
	// the request with the same clientToken parameter value.
	//
	// If you omit a clientToken value, the Amazon Web Services SDK that you are using
	// inserts a value for you. This way, the SDK can safely retry requests multiple
	// times after a network error. You must provide your own value for other use
	// cases.
	//
	// If you specify input parameters that differ from your first request, an error
	// occurs. If you use a different value for clientToken , Amazon AppFlow considers
	// it a new call to UpdateFlow . The token is active for 8 hours.
	ClientToken *string

	//  A description of the flow.
	Description *string

	// Specifies the configuration that Amazon AppFlow uses when it catalogs the data
	// that's transferred by the associated flow. When Amazon AppFlow catalogs the data
	// from a flow, it stores metadata in a data catalog.
	MetadataCatalogConfig *types.MetadataCatalogConfig
	// contains filtered or unexported fields
}

type UpdateFlowOutput 

type UpdateFlowOutput struct {

	// Indicates the current status of the flow.
	FlowStatus types.FlowStatus

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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