databrew

package module
v1.22.5 Latest Latest
Warning

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

 Go to latest Published: Aug 21, 2023 License: Apache-2.0 Imports: 35 Imported by: 3

Documentation

Overview

Package databrew provides the API client, operations, and parameter types for AWS Glue DataBrew.

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-07-25"
View Source 
const ServiceID = "DataBrew"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

Types

type BatchDeleteRecipeVersionInput 

type BatchDeleteRecipeVersionInput struct {

	// The name of the recipe whose versions are to be deleted.
	//
	// This member is required.
	Name *string

	// An array of version identifiers, for the recipe versions to be deleted. You can
	// specify numeric versions ( X.Y ) or LATEST_WORKING . LATEST_PUBLISHED is not
	// supported.
	//
	// This member is required.
	RecipeVersions []string
	// contains filtered or unexported fields
}

type BatchDeleteRecipeVersionOutput 

type BatchDeleteRecipeVersionOutput struct {

	// The name of the recipe that was modified.
	//
	// This member is required.
	Name *string

	// Errors, if any, that occurred while attempting to delete the recipe versions.
	Errors []types.RecipeVersionErrorDetail

	// 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 AWS Glue DataBrew.

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) BatchDeleteRecipeVersion 

func (c *Client) BatchDeleteRecipeVersion(ctx context.Context, params *BatchDeleteRecipeVersionInput, optFns ...func(*Options)) (*BatchDeleteRecipeVersionOutput, error)

Deletes one or more versions of a recipe at a time. The entire request will be rejected if:

  • The recipe does not exist.
  • There is an invalid version identifier in the list of versions.
  • The version list is empty.
  • The version list size exceeds 50.
  • The version list contains duplicate entries.

The request will complete successfully, but with partial failures, if:

  • A version does not exist.
  • A version is being used by a job.
  • You specify LATEST_WORKING , but it's being used by a project.
  • The version fails to be deleted.

The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates a new DataBrew dataset.

func (*Client) CreateProfileJob 

func (c *Client) CreateProfileJob(ctx context.Context, params *CreateProfileJobInput, optFns ...func(*Options)) (*CreateProfileJobOutput, error)

Creates a new job to analyze a dataset and create its data profile.

func (*Client) CreateProject 

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a new DataBrew project.

func (*Client) CreateRecipe 

func (c *Client) CreateRecipe(ctx context.Context, params *CreateRecipeInput, optFns ...func(*Options)) (*CreateRecipeOutput, error)

Creates a new DataBrew recipe.

func (*Client) CreateRecipeJob 

func (c *Client) CreateRecipeJob(ctx context.Context, params *CreateRecipeJobInput, optFns ...func(*Options)) (*CreateRecipeJobOutput, error)

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

func (*Client) CreateRuleset added in v1.13.0 

func (c *Client) CreateRuleset(ctx context.Context, params *CreateRulesetInput, optFns ...func(*Options)) (*CreateRulesetOutput, error)

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

func (*Client) CreateSchedule 

func (c *Client) CreateSchedule(ctx context.Context, params *CreateScheduleInput, optFns ...func(*Options)) (*CreateScheduleOutput, error)

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

Deletes a dataset from DataBrew.

func (*Client) DeleteJob 

func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns ...func(*Options)) (*DeleteJobOutput, error)

Deletes the specified DataBrew job.

func (*Client) DeleteProject 

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes an existing DataBrew project.

func (*Client) DeleteRecipeVersion 

func (c *Client) DeleteRecipeVersion(ctx context.Context, params *DeleteRecipeVersionInput, optFns ...func(*Options)) (*DeleteRecipeVersionOutput, error)

Deletes a single version of a DataBrew recipe.

func (*Client) DeleteRuleset added in v1.13.0 

func (c *Client) DeleteRuleset(ctx context.Context, params *DeleteRulesetInput, optFns ...func(*Options)) (*DeleteRulesetOutput, error)

Deletes a ruleset.

func (*Client) DeleteSchedule 

func (c *Client) DeleteSchedule(ctx context.Context, params *DeleteScheduleInput, optFns ...func(*Options)) (*DeleteScheduleOutput, error)

Deletes the specified DataBrew schedule.

func (*Client) DescribeDataset 

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Returns the definition of a specific DataBrew dataset.

func (*Client) DescribeJob 

func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error)

Returns the definition of a specific DataBrew job.

func (*Client) DescribeJobRun added in v1.2.0 

func (c *Client) DescribeJobRun(ctx context.Context, params *DescribeJobRunInput, optFns ...func(*Options)) (*DescribeJobRunOutput, error)

Represents one run of a DataBrew job.

func (*Client) DescribeProject 

func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)

Returns the definition of a specific DataBrew project.

func (*Client) DescribeRecipe 

func (c *Client) DescribeRecipe(ctx context.Context, params *DescribeRecipeInput, optFns ...func(*Options)) (*DescribeRecipeOutput, error)

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

func (*Client) DescribeRuleset added in v1.13.0 

func (c *Client) DescribeRuleset(ctx context.Context, params *DescribeRulesetInput, optFns ...func(*Options)) (*DescribeRulesetOutput, error)

Retrieves detailed information about the ruleset.

func (*Client) DescribeSchedule 

func (c *Client) DescribeSchedule(ctx context.Context, params *DescribeScheduleInput, optFns ...func(*Options)) (*DescribeScheduleOutput, error)

Returns the definition of a specific DataBrew schedule.

func (*Client) ListDatasets 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

Lists all of the DataBrew datasets.

func (*Client) ListJobRuns 

func (c *Client) ListJobRuns(ctx context.Context, params *ListJobRunsInput, optFns ...func(*Options)) (*ListJobRunsOutput, error)

Lists all of the previous runs of a particular DataBrew job.

func (*Client) ListJobs 

func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)

Lists all of the DataBrew jobs that are defined.

func (*Client) ListProjects 

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Lists all of the DataBrew projects that are defined.

func (*Client) ListRecipeVersions 

func (c *Client) ListRecipeVersions(ctx context.Context, params *ListRecipeVersionsInput, optFns ...func(*Options)) (*ListRecipeVersionsOutput, error)

Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING .

func (*Client) ListRecipes 

func (c *Client) ListRecipes(ctx context.Context, params *ListRecipesInput, optFns ...func(*Options)) (*ListRecipesOutput, error)

Lists all of the DataBrew recipes that are defined.

func (*Client) ListRulesets added in v1.13.0 

func (c *Client) ListRulesets(ctx context.Context, params *ListRulesetsInput, optFns ...func(*Options)) (*ListRulesetsOutput, error)

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

func (*Client) ListSchedules 

func (c *Client) ListSchedules(ctx context.Context, params *ListSchedulesInput, optFns ...func(*Options)) (*ListSchedulesOutput, error)

Lists the DataBrew schedules that are defined.

func (*Client) ListTagsForResource 

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

Lists all the tags for a DataBrew resource.

func (*Client) PublishRecipe 

func (c *Client) PublishRecipe(ctx context.Context, params *PublishRecipeInput, optFns ...func(*Options)) (*PublishRecipeOutput, error)

Publishes a new version of a DataBrew recipe.

func (*Client) SendProjectSessionAction 

func (c *Client) SendProjectSessionAction(ctx context.Context, params *SendProjectSessionActionInput, optFns ...func(*Options)) (*SendProjectSessionActionOutput, error)

Performs a recipe step within an interactive DataBrew session that's currently open.

func (*Client) StartJobRun 

func (c *Client) StartJobRun(ctx context.Context, params *StartJobRunInput, optFns ...func(*Options)) (*StartJobRunOutput, error)

Runs a DataBrew job.

func (*Client) StartProjectSession 

func (c *Client) StartProjectSession(ctx context.Context, params *StartProjectSessionInput, optFns ...func(*Options)) (*StartProjectSessionOutput, error)

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

func (*Client) StopJobRun 

func (c *Client) StopJobRun(ctx context.Context, params *StopJobRunInput, optFns ...func(*Options)) (*StopJobRunOutput, error)

Stops a particular run of a job.

func (*Client) TagResource 

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

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.

func (*Client) UntagResource 

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

Removes metadata tags from a DataBrew resource.

func (*Client) UpdateDataset 

func (c *Client) UpdateDataset(ctx context.Context, params *UpdateDatasetInput, optFns ...func(*Options)) (*UpdateDatasetOutput, error)

Modifies the definition of an existing DataBrew dataset.

func (*Client) UpdateProfileJob 

func (c *Client) UpdateProfileJob(ctx context.Context, params *UpdateProfileJobInput, optFns ...func(*Options)) (*UpdateProfileJobOutput, error)

Modifies the definition of an existing profile job.

func (*Client) UpdateProject 

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Modifies the definition of an existing DataBrew project.

func (*Client) UpdateRecipe 

func (c *Client) UpdateRecipe(ctx context.Context, params *UpdateRecipeInput, optFns ...func(*Options)) (*UpdateRecipeOutput, error)

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

func (*Client) UpdateRecipeJob 

func (c *Client) UpdateRecipeJob(ctx context.Context, params *UpdateRecipeJobInput, optFns ...func(*Options)) (*UpdateRecipeJobOutput, error)

Modifies the definition of an existing DataBrew recipe job.

func (*Client) UpdateRuleset added in v1.13.0 

func (c *Client) UpdateRuleset(ctx context.Context, params *UpdateRulesetInput, optFns ...func(*Options)) (*UpdateRulesetOutput, error)

Updates specified ruleset.

func (*Client) UpdateSchedule 

func (c *Client) UpdateSchedule(ctx context.Context, params *UpdateScheduleInput, optFns ...func(*Options)) (*UpdateScheduleOutput, error)

Modifies the definition of an existing DataBrew schedule.

type CreateDatasetInput 

type CreateDatasetInput struct {

	// Represents information on how DataBrew can find data, in either the Glue Data
	// Catalog or Amazon S3.
	//
	// This member is required.
	Input *types.Input

	// The name of the dataset to be created. Valid characters are alphanumeric (A-Z,
	// a-z, 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// The file format of a dataset that is created from an Amazon S3 file or folder.
	Format types.InputFormat

	// Represents a set of options that define the structure of either comma-separated
	// value (CSV), Excel, or JSON input.
	FormatOptions *types.FormatOptions

	// A set of options that defines how DataBrew interprets an Amazon S3 path of the
	// dataset.
	PathOptions *types.PathOptions

	// Metadata tags to apply to this dataset.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDatasetOutput 

type CreateDatasetOutput struct {

	// The name of the dataset that you created.
	//
	// This member is required.
	Name *string

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

type CreateProfileJobInput 

type CreateProfileJobInput struct {

	// The name of the dataset that this job is to act upon.
	//
	// This member is required.
	DatasetName *string

	// The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z,
	// 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// Represents an Amazon S3 location (bucket name, bucket owner, and object key)
	// where DataBrew can read input data, or write output from a job.
	//
	// This member is required.
	OutputLocation *types.S3Location

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// to be assumed when DataBrew runs the job.
	//
	// This member is required.
	RoleArn *string

	// Configuration for profile jobs. Used to select columns, do evaluations, and
	// override default parameters of evaluations. When configuration is null, the
	// profile job will run with default settings.
	Configuration *types.ProfileConfiguration

	// The Amazon Resource Name (ARN) of an encryption key that is used to protect the
	// job.
	EncryptionKeyArn *string

	// The encryption mode for the job, which can be one of the following:
	//   - SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
	//   - SSE-S3 - Server-side encryption with keys managed by Amazon S3.
	EncryptionMode types.EncryptionMode

	// Sample configuration for profile jobs only. Determines the number of rows on
	// which the profile job will be executed. If a JobSample value is not provided,
	// the default value will be used. The default value is CUSTOM_ROWS for the mode
	// parameter and 20000 for the size parameter.
	JobSample *types.JobSample

	// Enables or disables Amazon CloudWatch logging for the job. If logging is
	// enabled, CloudWatch writes one log stream for each job run.
	LogSubscription types.LogSubscription

	// The maximum number of nodes that DataBrew can use when the job processes data.
	MaxCapacity int32

	// The maximum number of times to retry the job after a job run fails.
	MaxRetries int32

	// Metadata tags to apply to this job.
	Tags map[string]string

	// The job's timeout in minutes. A job that attempts to run longer than this
	// timeout period ends with a status of TIMEOUT .
	Timeout int32

	// List of validation configurations that are applied to the profile job.
	ValidationConfigurations []types.ValidationConfiguration
	// contains filtered or unexported fields
}

type CreateProfileJobOutput 

type CreateProfileJobOutput struct {

	// The name of the job that was created.
	//
	// This member is required.
	Name *string

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

type CreateProjectInput 

type CreateProjectInput struct {

	// The name of an existing dataset to associate this project with.
	//
	// This member is required.
	DatasetName *string

	// A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z,
	// 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// The name of an existing recipe to associate with the project.
	//
	// This member is required.
	RecipeName *string

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// to be assumed for this request.
	//
	// This member is required.
	RoleArn *string

	// Represents the sample size and sampling type for DataBrew to use for
	// interactive data analysis.
	Sample *types.Sample

	// Metadata tags to apply to this project.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateProjectOutput 

type CreateProjectOutput struct {

	// The name of the project that you created.
	//
	// This member is required.
	Name *string

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

type CreateRecipeInput 

type CreateRecipeInput struct {

	// A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z,
	// 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// An array containing the steps to be performed by the recipe. Each recipe step
	// consists of one recipe action and (optionally) an array of condition
	// expressions.
	//
	// This member is required.
	Steps []types.RecipeStep

	// A description for the recipe.
	Description *string

	// Metadata tags to apply to this recipe.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRecipeJobInput 

type CreateRecipeJobInput struct {

	// A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9),
	// hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// to be assumed when DataBrew runs the job.
	//
	// This member is required.
	RoleArn *string

	// One or more artifacts that represent the Glue Data Catalog output from running
	// the job.
	DataCatalogOutputs []types.DataCatalogOutput

	// Represents a list of JDBC database output objects which defines the output
	// destination for a DataBrew recipe job to write to.
	DatabaseOutputs []types.DatabaseOutput

	// The name of the dataset that this job processes.
	DatasetName *string

	// The Amazon Resource Name (ARN) of an encryption key that is used to protect the
	// job.
	EncryptionKeyArn *string

	// The encryption mode for the job, which can be one of the following:
	//   - SSE-KMS - Server-side encryption with keys managed by KMS.
	//   - SSE-S3 - Server-side encryption with keys managed by Amazon S3.
	EncryptionMode types.EncryptionMode

	// Enables or disables Amazon CloudWatch logging for the job. If logging is
	// enabled, CloudWatch writes one log stream for each job run.
	LogSubscription types.LogSubscription

	// The maximum number of nodes that DataBrew can consume when the job processes
	// data.
	MaxCapacity int32

	// The maximum number of times to retry the job after a job run fails.
	MaxRetries int32

	// One or more artifacts that represent the output from running the job.
	Outputs []types.Output

	// Either the name of an existing project, or a combination of a recipe and a
	// dataset to associate with the recipe.
	ProjectName *string

	// Represents the name and version of a DataBrew recipe.
	RecipeReference *types.RecipeReference

	// Metadata tags to apply to this job.
	Tags map[string]string

	// The job's timeout in minutes. A job that attempts to run longer than this
	// timeout period ends with a status of TIMEOUT .
	Timeout int32
	// contains filtered or unexported fields
}

type CreateRecipeJobOutput 

type CreateRecipeJobOutput struct {

	// The name of the job that you created.
	//
	// This member is required.
	Name *string

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

type CreateRecipeOutput 

type CreateRecipeOutput struct {

	// The name of the recipe that you created.
	//
	// This member is required.
	Name *string

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

type CreateRulesetInput added in v1.13.0 

type CreateRulesetInput struct {

	// The name of the ruleset to be created. Valid characters are alphanumeric (A-Z,
	// a-z, 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// A list of rules that are defined with the ruleset. A rule includes one or more
	// checks to be validated on a DataBrew dataset.
	//
	// This member is required.
	Rules []types.Rule

	// The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
	// associated with.
	//
	// This member is required.
	TargetArn *string

	// The description of the ruleset.
	Description *string

	// Metadata tags to apply to the ruleset.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRulesetOutput added in v1.13.0 

type CreateRulesetOutput struct {

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

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

type CreateScheduleInput 

type CreateScheduleInput struct {

	// The date or dates and time or times when the jobs are to be run. For more
	// information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)
	// in the Glue DataBrew Developer Guide.
	//
	// This member is required.
	CronExpression *string

	// A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z,
	// 0-9), hyphen (-), period (.), and space.
	//
	// This member is required.
	Name *string

	// The name or names of one or more jobs to be run.
	JobNames []string

	// Metadata tags to apply to this schedule.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateScheduleOutput 

type CreateScheduleOutput struct {

	// The name of the schedule that was created.
	//
	// This member is required.
	Name *string

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

type DeleteDatasetInput 

type DeleteDatasetInput struct {

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

type DeleteDatasetOutput 

type DeleteDatasetOutput struct {

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

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

type DeleteJobInput 

type DeleteJobInput struct {

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

type DeleteJobOutput 

type DeleteJobOutput struct {

	// The name of the job that you deleted.
	//
	// This member is required.
	Name *string

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

type DeleteProjectInput 

type DeleteProjectInput struct {

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

type DeleteProjectOutput 

type DeleteProjectOutput struct {

	// The name of the project that you deleted.
	//
	// This member is required.
	Name *string

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

type DeleteRecipeVersionInput 

type DeleteRecipeVersionInput struct {

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

	// The version of the recipe to be deleted. You can specify a numeric versions ( X.Y
	// ) or LATEST_WORKING . LATEST_PUBLISHED is not supported.
	//
	// This member is required.
	RecipeVersion *string
	// contains filtered or unexported fields
}

type DeleteRecipeVersionOutput 

type DeleteRecipeVersionOutput struct {

	// The name of the recipe that was deleted.
	//
	// This member is required.
	Name *string

	// The version of the recipe that was deleted.
	//
	// This member is required.
	RecipeVersion *string

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

type DeleteRulesetInput added in v1.13.0 

type DeleteRulesetInput struct {

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

type DeleteRulesetOutput added in v1.13.0 

type DeleteRulesetOutput struct {

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

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

type DeleteScheduleInput 

type DeleteScheduleInput struct {

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

type DeleteScheduleOutput 

type DeleteScheduleOutput struct {

	// The name of the schedule that was deleted.
	//
	// This member is required.
	Name *string

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

type DescribeDatasetInput 

type DescribeDatasetInput struct {

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

type DescribeDatasetOutput 

type DescribeDatasetOutput struct {

	// Represents information on how DataBrew can find data, in either the Glue Data
	// Catalog or Amazon S3.
	//
	// This member is required.
	Input *types.Input

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

	// The date and time that the dataset was created.
	CreateDate *time.Time

	// The identifier (user name) of the user who created the dataset.
	CreatedBy *string

	// The file format of a dataset that is created from an Amazon S3 file or folder.
	Format types.InputFormat

	// Represents a set of options that define the structure of either comma-separated
	// value (CSV), Excel, or JSON input.
	FormatOptions *types.FormatOptions

	// The identifier (user name) of the user who last modified the dataset.
	LastModifiedBy *string

	// The date and time that the dataset was last modified.
	LastModifiedDate *time.Time

	// A set of options that defines how DataBrew interprets an Amazon S3 path of the
	// dataset.
	PathOptions *types.PathOptions

	// The Amazon Resource Name (ARN) of the dataset.
	ResourceArn *string

	// The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
	Source types.Source

	// Metadata tags associated with this dataset.
	Tags map[string]string

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

type DescribeJobInput 

type DescribeJobInput struct {

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

type DescribeJobOutput 

type DescribeJobOutput struct {

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

	// The date and time that the job was created.
	CreateDate *time.Time

	// The identifier (user name) of the user associated with the creation of the job.
	CreatedBy *string

	// One or more artifacts that represent the Glue Data Catalog output from running
	// the job.
	DataCatalogOutputs []types.DataCatalogOutput

	// Represents a list of JDBC database output objects which defines the output
	// destination for a DataBrew recipe job to write into.
	DatabaseOutputs []types.DatabaseOutput

	// The dataset that the job acts upon.
	DatasetName *string

	// The Amazon Resource Name (ARN) of an encryption key that is used to protect the
	// job.
	EncryptionKeyArn *string

	// The encryption mode for the job, which can be one of the following:
	//   - SSE-KMS - Server-side encryption with keys managed by KMS.
	//   - SSE-S3 - Server-side encryption with keys managed by Amazon S3.
	EncryptionMode types.EncryptionMode

	// Sample configuration for profile jobs only. Determines the number of rows on
	// which the profile job will be executed.
	JobSample *types.JobSample

	// The identifier (user name) of the user who last modified the job.
	LastModifiedBy *string

	// The date and time that the job was last modified.
	LastModifiedDate *time.Time

	// Indicates whether Amazon CloudWatch logging is enabled for this job.
	LogSubscription types.LogSubscription

	// The maximum number of compute nodes that DataBrew can consume when the job
	// processes data.
	MaxCapacity int32

	// The maximum number of times to retry the job after a job run fails.
	MaxRetries int32

	// One or more artifacts that represent the output from running the job.
	Outputs []types.Output

	// Configuration for profile jobs. Used to select columns, do evaluations, and
	// override default parameters of evaluations. When configuration is null, the
	// profile job will run with default settings.
	ProfileConfiguration *types.ProfileConfiguration

	// The DataBrew project associated with this job.
	ProjectName *string

	// Represents the name and version of a DataBrew recipe.
	RecipeReference *types.RecipeReference

	// The Amazon Resource Name (ARN) of the job.
	ResourceArn *string

	// The ARN of the Identity and Access Management (IAM) role to be assumed when
	// DataBrew runs the job.
	RoleArn *string

	// Metadata tags associated with this job.
	Tags map[string]string

	// The job's timeout in minutes. A job that attempts to run longer than this
	// timeout period ends with a status of TIMEOUT .
	Timeout int32

	// The job type, which must be one of the following:
	//   - PROFILE - The job analyzes the dataset to determine its size, data types,
	//   data distribution, and more.
	//   - RECIPE - The job applies one or more transformations to a dataset.
	Type types.JobType

	// List of validation configurations that are applied to the profile job.
	ValidationConfigurations []types.ValidationConfiguration

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

type DescribeJobRunInput added in v1.2.0 

type DescribeJobRunInput struct {

	// The name of the job being processed during this run.
	//
	// This member is required.
	Name *string

	// The unique identifier of the job run.
	//
	// This member is required.
	RunId *string
	// contains filtered or unexported fields
}

type DescribeJobRunOutput added in v1.2.0 

type DescribeJobRunOutput struct {

	// The name of the job being processed during this run.
	//
	// This member is required.
	JobName *string

	// The number of times that DataBrew has attempted to run the job.
	Attempt int32

	// The date and time when the job completed processing.
	CompletedOn *time.Time

	// One or more artifacts that represent the Glue Data Catalog output from running
	// the job.
	DataCatalogOutputs []types.DataCatalogOutput

	// Represents a list of JDBC database output objects which defines the output
	// destination for a DataBrew recipe job to write into.
	DatabaseOutputs []types.DatabaseOutput

	// The name of the dataset for the job to process.
	DatasetName *string

	// A message indicating an error (if any) that was encountered when the job ran.
	ErrorMessage *string

	// The amount of time, in seconds, during which the job run consumed resources.
	ExecutionTime int32

	// Sample configuration for profile jobs only. Determines the number of rows on
	// which the profile job will be executed. If a JobSample value is not provided,
	// the default value will be used. The default value is CUSTOM_ROWS for the mode
	// parameter and 20000 for the size parameter.
	JobSample *types.JobSample

	// The name of an Amazon CloudWatch log group, where the job writes diagnostic
	// messages when it runs.
	LogGroupName *string

	// The current status of Amazon CloudWatch logging for the job run.
	LogSubscription types.LogSubscription

	// One or more output artifacts from a job run.
	Outputs []types.Output

	// Configuration for profile jobs. Used to select columns, do evaluations, and
	// override default parameters of evaluations. When configuration is null, the
	// profile job will run with default settings.
	ProfileConfiguration *types.ProfileConfiguration

	// Represents the name and version of a DataBrew recipe.
	RecipeReference *types.RecipeReference

	// The unique identifier of the job run.
	RunId *string

	// The Amazon Resource Name (ARN) of the user who started the job run.
	StartedBy *string

	// The date and time when the job run began.
	StartedOn *time.Time

	// The current state of the job run entity itself.
	State types.JobRunState

	// List of validation configurations that are applied to the profile job.
	ValidationConfigurations []types.ValidationConfiguration

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

type DescribeProjectInput 

type DescribeProjectInput struct {

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

type DescribeProjectOutput 

type DescribeProjectOutput struct {

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

	// The date and time that the project was created.
	CreateDate *time.Time

	// The identifier (user name) of the user who created the project.
	CreatedBy *string

	// The dataset associated with the project.
	DatasetName *string

	// The identifier (user name) of the user who last modified the project.
	LastModifiedBy *string

	// The date and time that the project was last modified.
	LastModifiedDate *time.Time

	// The date and time when the project was opened.
	OpenDate *time.Time

	// The identifier (user name) of the user that opened the project for use.
	OpenedBy *string

	// The recipe associated with this job.
	RecipeName *string

	// The Amazon Resource Name (ARN) of the project.
	ResourceArn *string

	// The ARN of the Identity and Access Management (IAM) role to be assumed when
	// DataBrew runs the job.
	RoleArn *string

	// Represents the sample size and sampling type for DataBrew to use for
	// interactive data analysis.
	Sample *types.Sample

	// Describes the current state of the session:
	//   - PROVISIONING - allocating resources for the session.
	//   - INITIALIZING - getting the session ready for first use.
	//   - ASSIGNED - the session is ready for use.
	SessionStatus types.SessionStatus

	// Metadata tags associated with this project.
	Tags map[string]string

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

type DescribeRecipeInput 

type DescribeRecipeInput struct {

	// The name of the recipe to be described.
	//
	// This member is required.
	Name *string

	// The recipe version identifier. If this parameter isn't specified, then the
	// latest published version is returned.
	RecipeVersion *string
	// contains filtered or unexported fields
}

type DescribeRecipeOutput 

type DescribeRecipeOutput struct {

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

	// The date and time that the recipe was created.
	CreateDate *time.Time

	// The identifier (user name) of the user who created the recipe.
	CreatedBy *string

	// The description of the recipe.
	Description *string

	// The identifier (user name) of the user who last modified the recipe.
	LastModifiedBy *string

	// The date and time that the recipe was last modified.
	LastModifiedDate *time.Time

	// The name of the project associated with this recipe.
	ProjectName *string

	// The identifier (user name) of the user who last published the recipe.
	PublishedBy *string

	// The date and time when the recipe was last published.
	PublishedDate *time.Time

	// The recipe version identifier.
	RecipeVersion *string

	// The ARN of the recipe.
	ResourceArn *string

	// One or more steps to be performed by the recipe. Each step consists of an
	// action, and the conditions under which the action should succeed.
	Steps []types.RecipeStep

	// Metadata tags associated with this project.
	Tags map[string]string

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

type DescribeRulesetInput added in v1.13.0 

type DescribeRulesetInput struct {

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

type DescribeRulesetOutput added in v1.13.0 

type DescribeRulesetOutput struct {

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

	// The date and time that the ruleset was created.
	CreateDate *time.Time

	// The Amazon Resource Name (ARN) of the user who created the ruleset.
	CreatedBy *string

	// The description of the ruleset.
	Description *string

	// The Amazon Resource Name (ARN) of the user who last modified the ruleset.
	LastModifiedBy *string

	// The modification date and time of the ruleset.
	LastModifiedDate *time.Time

	// The Amazon Resource Name (ARN) for the ruleset.
	ResourceArn *string

	// A list of rules that are defined with the ruleset. A rule includes one or more
	// checks to be validated on a DataBrew dataset.
	Rules []types.Rule

	// Metadata tags that have been applied to the ruleset.
	Tags map[string]string

	// The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is
	// associated with.
	TargetArn *string

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

type DescribeScheduleInput 

type DescribeScheduleInput struct {

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

type DescribeScheduleOutput 

type DescribeScheduleOutput struct {

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

	// The date and time that the schedule was created.
	CreateDate *time.Time

	// The identifier (user name) of the user who created the schedule.
	CreatedBy *string

	// The date or dates and time or times when the jobs are to be run for the
	// schedule. For more information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)
	// in the Glue DataBrew Developer Guide.
	CronExpression *string

	// The name or names of one or more jobs to be run by using the schedule.
	JobNames []string

	// The identifier (user name) of the user who last modified the schedule.
	LastModifiedBy *string

	// The date and time that the schedule was last modified.
	LastModifiedDate *time.Time

	// The Amazon Resource Name (ARN) of the schedule.
	ResourceArn *string

	// Metadata tags associated with this schedule.
	Tags map[string]string

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

type EndpointParameters added in v1.22.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.22.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.22.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.22.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.22.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 ListDatasetsAPIClient 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// A list of datasets that are defined.
	//
	// This member is required.
	Datasets []types.Dataset

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListDatasetsPaginator 

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

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions 

type ListDatasetsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListJobRunsAPIClient 

type ListJobRunsAPIClient interface {
	ListJobRuns(context.Context, *ListJobRunsInput, ...func(*Options)) (*ListJobRunsOutput, error)
}

ListJobRunsAPIClient is a client that implements the ListJobRuns operation.

type ListJobRunsInput 

type ListJobRunsInput struct {

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

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListJobRunsOutput 

type ListJobRunsOutput struct {

	// A list of job runs that have occurred for the specified job.
	//
	// This member is required.
	JobRuns []types.JobRun

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListJobRunsPaginator 

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

ListJobRunsPaginator is a paginator for ListJobRuns

func NewListJobRunsPaginator 

func NewListJobRunsPaginator(client ListJobRunsAPIClient, params *ListJobRunsInput, optFns ...func(*ListJobRunsPaginatorOptions)) *ListJobRunsPaginator

NewListJobRunsPaginator returns a new ListJobRunsPaginator

func (*ListJobRunsPaginator) HasMorePages 

func (p *ListJobRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobRunsPaginator) NextPage 

func (p *ListJobRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobRunsOutput, error)

NextPage retrieves the next ListJobRuns page.

type ListJobRunsPaginatorOptions 

type ListJobRunsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListJobRunsPaginatorOptions is the paginator options for ListJobRuns

type ListJobsAPIClient 

type ListJobsAPIClient interface {
	ListJobs(context.Context, *ListJobsInput, ...func(*Options)) (*ListJobsOutput, error)
}

ListJobsAPIClient is a client that implements the ListJobs operation.

type ListJobsInput 

type ListJobsInput struct {

	// The name of a dataset. Using this parameter indicates to return only those jobs
	// that act on the specified dataset.
	DatasetName *string

	// The maximum number of results to return in this request.
	MaxResults *int32

	// A token generated by DataBrew that specifies where to continue pagination if a
	// previous request was truncated. To get the next set of pages, pass in the
	// NextToken value from the response object of the previous page call.
	NextToken *string

	// The name of a project. Using this parameter indicates to return only those jobs
	// that are associated with the specified project.
	ProjectName *string
	// contains filtered or unexported fields
}

type ListJobsOutput 

type ListJobsOutput struct {

	// A list of jobs that are defined.
	//
	// This member is required.
	Jobs []types.Job

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListJobsPaginator 

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

ListJobsPaginator is a paginator for ListJobs

func NewListJobsPaginator 

func NewListJobsPaginator(client ListJobsAPIClient, params *ListJobsInput, optFns ...func(*ListJobsPaginatorOptions)) *ListJobsPaginator

NewListJobsPaginator returns a new ListJobsPaginator

func (*ListJobsPaginator) HasMorePages 

func (p *ListJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListJobsPaginator) NextPage 

func (p *ListJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListJobsOutput, error)

NextPage retrieves the next ListJobs page.

type ListJobsPaginatorOptions 

type ListJobsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListJobsPaginatorOptions is the paginator options for ListJobs

type ListProjectsAPIClient 

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput 

type ListProjectsInput struct {

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProjectsOutput 

type ListProjectsOutput struct {

	// A list of projects that are defined .
	//
	// This member is required.
	Projects []types.Project

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListProjectsPaginator 

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator 

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages 

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage 

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions 

type ListProjectsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListRecipeVersionsAPIClient 

type ListRecipeVersionsAPIClient interface {
	ListRecipeVersions(context.Context, *ListRecipeVersionsInput, ...func(*Options)) (*ListRecipeVersionsOutput, error)
}

ListRecipeVersionsAPIClient is a client that implements the ListRecipeVersions operation.

type ListRecipeVersionsInput 

type ListRecipeVersionsInput struct {

	// The name of the recipe for which to return version information.
	//
	// This member is required.
	Name *string

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecipeVersionsOutput 

type ListRecipeVersionsOutput struct {

	// A list of versions for the specified recipe.
	//
	// This member is required.
	Recipes []types.Recipe

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListRecipeVersionsPaginator 

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

ListRecipeVersionsPaginator is a paginator for ListRecipeVersions

func NewListRecipeVersionsPaginator 

func NewListRecipeVersionsPaginator(client ListRecipeVersionsAPIClient, params *ListRecipeVersionsInput, optFns ...func(*ListRecipeVersionsPaginatorOptions)) *ListRecipeVersionsPaginator

NewListRecipeVersionsPaginator returns a new ListRecipeVersionsPaginator

func (*ListRecipeVersionsPaginator) HasMorePages 

func (p *ListRecipeVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecipeVersionsPaginator) NextPage 

func (p *ListRecipeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecipeVersionsOutput, error)

NextPage retrieves the next ListRecipeVersions page.

type ListRecipeVersionsPaginatorOptions 

type ListRecipeVersionsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListRecipeVersionsPaginatorOptions is the paginator options for ListRecipeVersions

type ListRecipesAPIClient 

type ListRecipesAPIClient interface {
	ListRecipes(context.Context, *ListRecipesInput, ...func(*Options)) (*ListRecipesOutput, error)
}

ListRecipesAPIClient is a client that implements the ListRecipes operation.

type ListRecipesInput 

type ListRecipesInput struct {

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string

	// Return only those recipes with a version identifier of LATEST_WORKING or
	// LATEST_PUBLISHED . If RecipeVersion is omitted, ListRecipes returns all of the
	// LATEST_PUBLISHED recipe versions. Valid values: LATEST_WORKING |
	// LATEST_PUBLISHED
	RecipeVersion *string
	// contains filtered or unexported fields
}

type ListRecipesOutput 

type ListRecipesOutput struct {

	// A list of recipes that are defined.
	//
	// This member is required.
	Recipes []types.Recipe

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListRecipesPaginator 

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

ListRecipesPaginator is a paginator for ListRecipes

func NewListRecipesPaginator 

func NewListRecipesPaginator(client ListRecipesAPIClient, params *ListRecipesInput, optFns ...func(*ListRecipesPaginatorOptions)) *ListRecipesPaginator

NewListRecipesPaginator returns a new ListRecipesPaginator

func (*ListRecipesPaginator) HasMorePages 

func (p *ListRecipesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecipesPaginator) NextPage 

func (p *ListRecipesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecipesOutput, error)

NextPage retrieves the next ListRecipes page.

type ListRecipesPaginatorOptions 

type ListRecipesPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListRecipesPaginatorOptions is the paginator options for ListRecipes

type ListRulesetsAPIClient added in v1.13.0 

type ListRulesetsAPIClient interface {
	ListRulesets(context.Context, *ListRulesetsInput, ...func(*Options)) (*ListRulesetsOutput, error)
}

ListRulesetsAPIClient is a client that implements the ListRulesets operation.

type ListRulesetsInput added in v1.13.0 

type ListRulesetsInput struct {

	// The maximum number of results to return in this request.
	MaxResults *int32

	// A token generated by DataBrew that specifies where to continue pagination if a
	// previous request was truncated. To get the next set of pages, pass in the
	// NextToken value from the response object of the previous page call.
	NextToken *string

	// The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter
	// indicates to return only those rulesets that are associated with the specified
	// resource.
	TargetArn *string
	// contains filtered or unexported fields
}

type ListRulesetsOutput added in v1.13.0 

type ListRulesetsOutput struct {

	// A list of RulesetItem. RulesetItem contains meta data of a ruleset.
	//
	// This member is required.
	Rulesets []types.RulesetItem

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListRulesetsPaginator added in v1.13.0 

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

ListRulesetsPaginator is a paginator for ListRulesets

func NewListRulesetsPaginator added in v1.13.0 

func NewListRulesetsPaginator(client ListRulesetsAPIClient, params *ListRulesetsInput, optFns ...func(*ListRulesetsPaginatorOptions)) *ListRulesetsPaginator

NewListRulesetsPaginator returns a new ListRulesetsPaginator

func (*ListRulesetsPaginator) HasMorePages added in v1.13.0 

func (p *ListRulesetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRulesetsPaginator) NextPage added in v1.13.0 

func (p *ListRulesetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRulesetsOutput, error)

NextPage retrieves the next ListRulesets page.

type ListRulesetsPaginatorOptions added in v1.13.0 

type ListRulesetsPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListRulesetsPaginatorOptions is the paginator options for ListRulesets

type ListSchedulesAPIClient 

type ListSchedulesAPIClient interface {
	ListSchedules(context.Context, *ListSchedulesInput, ...func(*Options)) (*ListSchedulesOutput, error)
}

ListSchedulesAPIClient is a client that implements the ListSchedules operation.

type ListSchedulesInput 

type ListSchedulesInput struct {

	// The name of the job that these schedules apply to.
	JobName *string

	// The maximum number of results to return in this request.
	MaxResults *int32

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSchedulesOutput 

type ListSchedulesOutput struct {

	// A list of schedules that are defined.
	//
	// This member is required.
	Schedules []types.Schedule

	// A token that you can use in a subsequent call to retrieve the next set of
	// results.
	NextToken *string

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

type ListSchedulesPaginator 

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

ListSchedulesPaginator is a paginator for ListSchedules

func NewListSchedulesPaginator 

func NewListSchedulesPaginator(client ListSchedulesAPIClient, params *ListSchedulesInput, optFns ...func(*ListSchedulesPaginatorOptions)) *ListSchedulesPaginator

NewListSchedulesPaginator returns a new ListSchedulesPaginator

func (*ListSchedulesPaginator) HasMorePages 

func (p *ListSchedulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSchedulesPaginator) NextPage 

func (p *ListSchedulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchedulesOutput, error)

NextPage retrieves the next ListSchedules page.

type ListSchedulesPaginatorOptions 

type ListSchedulesPaginatorOptions struct {
	// The maximum number of results to return in this request.
	Limit int32

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

ListSchedulesPaginatorOptions is the paginator options for ListSchedules

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew
	// resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of tags associated with the DataBrew resource.
	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

	// 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. This should be used over
	// the deprecated EndpointResolver
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// 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. 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. 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
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

type PublishRecipeInput 

type PublishRecipeInput struct {

	// The name of the recipe to be published.
	//
	// This member is required.
	Name *string

	// A description of the recipe to be published, for this version of the recipe.
	Description *string
	// contains filtered or unexported fields
}

type PublishRecipeOutput 

type PublishRecipeOutput struct {

	// The name of the recipe that you published.
	//
	// This member is required.
	Name *string

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

type SendProjectSessionActionInput struct {

	// The name of the project to apply the action to.
	//
	// This member is required.
	Name *string

	// A unique identifier for an interactive session that's currently open and ready
	// for work. The action will be performed on this session.
	ClientSessionId *string

	// If true, the result of the recipe step will be returned, but not applied.
	Preview bool

	// Represents a single step from a DataBrew recipe to be performed.
	RecipeStep *types.RecipeStep

	// The index from which to preview a step. This index is used to preview the
	// result of steps that have already been applied, so that the resulting view frame
	// is from earlier in the view frame stack.
	StepIndex *int32

	// Represents the data being transformed during an action.
	ViewFrame *types.ViewFrame
	// contains filtered or unexported fields
}

type SendProjectSessionActionOutput 

type SendProjectSessionActionOutput struct {

	// The name of the project that was affected by the action.
	//
	// This member is required.
	Name *string

	// A unique identifier for the action that was performed.
	ActionId *int32

	// A message indicating the result of performing the action.
	Result *string

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

type StartJobRunInput 

type StartJobRunInput struct {

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

type StartJobRunOutput 

type StartJobRunOutput struct {

	// A system-generated identifier for this particular job run.
	//
	// This member is required.
	RunId *string

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

type StartProjectSessionInput 

type StartProjectSessionInput struct {

	// The name of the project to act upon.
	//
	// This member is required.
	Name *string

	// A value that, if true, enables you to take control of a session, even if a
	// different client is currently accessing the project.
	AssumeControl bool
	// contains filtered or unexported fields
}

type StartProjectSessionOutput 

type StartProjectSessionOutput struct {

	// The name of the project to be acted upon.
	//
	// This member is required.
	Name *string

	// A system-generated identifier for the session.
	ClientSessionId *string

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

type StopJobRunInput 

type StopJobRunInput struct {

	// The name of the job to be stopped.
	//
	// This member is required.
	Name *string

	// The ID of the job run to be stopped.
	//
	// This member is required.
	RunId *string
	// contains filtered or unexported fields
}

type StopJobRunOutput 

type StopJobRunOutput struct {

	// The ID of the job run that you stopped.
	//
	// This member is required.
	RunId *string

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

type TagResourceInput 

type TagResourceInput struct {

	// The DataBrew resource to which tags should be added. The value for this
	// parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset,
	// a job, a project, or a recipe.
	//
	// This member is required.
	ResourceArn *string

	// One or more tags to be assigned to the resource.
	//
	// 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 UntagResourceInput 

type UntagResourceInput struct {

	// A DataBrew resource from which you want to remove a tag or tags. The value for
	// this parameter is an Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// The tag keys (names) of one or more tags to be removed.
	//
	// 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 UpdateDatasetInput 

type UpdateDatasetInput struct {

	// Represents information on how DataBrew can find data, in either the Glue Data
	// Catalog or Amazon S3.
	//
	// This member is required.
	Input *types.Input

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

	// The file format of a dataset that is created from an Amazon S3 file or folder.
	Format types.InputFormat

	// Represents a set of options that define the structure of either comma-separated
	// value (CSV), Excel, or JSON input.
	FormatOptions *types.FormatOptions

	// A set of options that defines how DataBrew interprets an Amazon S3 path of the
	// dataset.
	PathOptions *types.PathOptions
	// contains filtered or unexported fields
}

type UpdateDatasetOutput 

type UpdateDatasetOutput struct {

	// The name of the dataset that you updated.
	//
	// This member is required.
	Name *string

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

type UpdateProfileJobInput 

type UpdateProfileJobInput struct {

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

	// Represents an Amazon S3 location (bucket name, bucket owner, and object key)
	// where DataBrew can read input data, or write output from a job.
	//
	// This member is required.
	OutputLocation *types.S3Location

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// to be assumed when DataBrew runs the job.
	//
	// This member is required.
	RoleArn *string

	// Configuration for profile jobs. Used to select columns, do evaluations, and
	// override default parameters of evaluations. When configuration is null, the
	// profile job will run with default settings.
	Configuration *types.ProfileConfiguration

	// The Amazon Resource Name (ARN) of an encryption key that is used to protect the
	// job.
	EncryptionKeyArn *string

	// The encryption mode for the job, which can be one of the following:
	//   - SSE-KMS - Server-side encryption with keys managed by KMS.
	//   - SSE-S3 - Server-side encryption with keys managed by Amazon S3.
	EncryptionMode types.EncryptionMode

	// Sample configuration for Profile Jobs only. Determines the number of rows on
	// which the Profile job will be executed. If a JobSample value is not provided for
	// profile jobs, the default value will be used. The default value is CUSTOM_ROWS
	// for the mode parameter and 20000 for the size parameter.
	JobSample *types.JobSample

	// Enables or disables Amazon CloudWatch logging for the job. If logging is
	// enabled, CloudWatch writes one log stream for each job run.
	LogSubscription types.LogSubscription

	// The maximum number of compute nodes that DataBrew can use when the job
	// processes data.
	MaxCapacity int32

	// The maximum number of times to retry the job after a job run fails.
	MaxRetries int32

	// The job's timeout in minutes. A job that attempts to run longer than this
	// timeout period ends with a status of TIMEOUT .
	Timeout int32

	// List of validation configurations that are applied to the profile job.
	ValidationConfigurations []types.ValidationConfiguration
	// contains filtered or unexported fields
}

type UpdateProfileJobOutput 

type UpdateProfileJobOutput struct {

	// The name of the job that was updated.
	//
	// This member is required.
	Name *string

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

type UpdateProjectInput 

type UpdateProjectInput struct {

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

	// The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.
	//
	// This member is required.
	RoleArn *string

	// Represents the sample size and sampling type for DataBrew to use for
	// interactive data analysis.
	Sample *types.Sample
	// contains filtered or unexported fields
}

type UpdateProjectOutput 

type UpdateProjectOutput struct {

	// The name of the project that you updated.
	//
	// This member is required.
	Name *string

	// The date and time that the project was last modified.
	LastModifiedDate *time.Time

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

type UpdateRecipeInput 

type UpdateRecipeInput struct {

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

	// A description of the recipe.
	Description *string

	// One or more steps to be performed by the recipe. Each step consists of an
	// action, and the conditions under which the action should succeed.
	Steps []types.RecipeStep
	// contains filtered or unexported fields
}

type UpdateRecipeJobInput 

type UpdateRecipeJobInput struct {

	// The name of the job to update.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
	// to be assumed when DataBrew runs the job.
	//
	// This member is required.
	RoleArn *string

	// One or more artifacts that represent the Glue Data Catalog output from running
	// the job.
	DataCatalogOutputs []types.DataCatalogOutput

	// Represents a list of JDBC database output objects which defines the output
	// destination for a DataBrew recipe job to write into.
	DatabaseOutputs []types.DatabaseOutput

	// The Amazon Resource Name (ARN) of an encryption key that is used to protect the
	// job.
	EncryptionKeyArn *string

	// The encryption mode for the job, which can be one of the following:
	//   - SSE-KMS - Server-side encryption with keys managed by KMS.
	//   - SSE-S3 - Server-side encryption with keys managed by Amazon S3.
	EncryptionMode types.EncryptionMode

	// Enables or disables Amazon CloudWatch logging for the job. If logging is
	// enabled, CloudWatch writes one log stream for each job run.
	LogSubscription types.LogSubscription

	// The maximum number of nodes that DataBrew can consume when the job processes
	// data.
	MaxCapacity int32

	// The maximum number of times to retry the job after a job run fails.
	MaxRetries int32

	// One or more artifacts that represent the output from running the job.
	Outputs []types.Output

	// The job's timeout in minutes. A job that attempts to run longer than this
	// timeout period ends with a status of TIMEOUT .
	Timeout int32
	// contains filtered or unexported fields
}

type UpdateRecipeJobOutput 

type UpdateRecipeJobOutput struct {

	// The name of the job that you updated.
	//
	// This member is required.
	Name *string

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

type UpdateRecipeOutput 

type UpdateRecipeOutput struct {

	// The name of the recipe that was updated.
	//
	// This member is required.
	Name *string

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

type UpdateRulesetInput added in v1.13.0 

type UpdateRulesetInput struct {

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

	// A list of rules that are defined with the ruleset. A rule includes one or more
	// checks to be validated on a DataBrew dataset.
	//
	// This member is required.
	Rules []types.Rule

	// The description of the ruleset.
	Description *string
	// contains filtered or unexported fields
}

type UpdateRulesetOutput added in v1.13.0 

type UpdateRulesetOutput struct {

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

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

type UpdateScheduleInput 

type UpdateScheduleInput struct {

	// The date or dates and time or times when the jobs are to be run. For more
	// information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html)
	// in the Glue DataBrew Developer Guide.
	//
	// This member is required.
	CronExpression *string

	// The name of the schedule to update.
	//
	// This member is required.
	Name *string

	// The name or names of one or more jobs to be run for this schedule.
	JobNames []string
	// contains filtered or unexported fields
}

type UpdateScheduleOutput 

type UpdateScheduleOutput struct {

	// The name of the schedule that was updated.
	//
	// This member is required.
	Name *string

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