honeycode

package module
v1.21.5 Latest Latest
Warning

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

 Go to latest Published: May 8, 2024 License: Apache-2.0 Imports: 38 Imported by: 4

Documentation

Overview

Package honeycode provides the API client, operations, and parameter types for Amazon Honeycode. 

Amazon Honeycode is a fully managed service that allows you to quickly build

mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-03-01"
View Source 
const ServiceID = "Honeycode"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.18.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.18.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.18.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.18.2 

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

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

type BatchCreateTableRowsInput added in v0.31.0 

type BatchCreateTableRowsInput struct {

	//  The list of rows to create at the end of the table. Each item in this list
	// needs to have a batch item id to uniquely identify the element in the request
	// and the cells to create for that row. You need to specify at least one item in
	// this list.
	//
	// Note that if one of the column ids in any of the rows in the request does not
	// exist in the table, then the request fails and no updates are made to the table.
	//
	// This member is required.
	RowsToCreate []types.CreateRowData

	// The ID of the table where the new rows are being added.
	//
	// If a table with the specified ID could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook where the new rows are being added.
	//
	// If a workbook with the specified ID could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	//  The request token for performing the batch create operation. Request tokens
	// help to identify duplicate requests. If a call times out or fails due to a
	// transient error like a failed network connection, you can retry the call with
	// the same request token. The service ensures that if the first call using that
	// request token is successfully performed, the second call will not perform the
	// operation again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type BatchCreateTableRowsOutput added in v0.31.0 

type BatchCreateTableRowsOutput struct {

	// The map of batch item id to the row id that was created for that item.
	//
	// This member is required.
	CreatedRows map[string]string

	// The updated workbook cursor after adding the new rows at the end of the table.
	//
	// This member is required.
	WorkbookCursor int64

	//  The list of batch items in the request that could not be added to the table.
	// Each element in this list contains one item from the request that could not be
	// added to the table along with the reason why that item could not be added.
	FailedBatchItems []types.FailedBatchItem

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

type BatchDeleteTableRowsInput added in v0.31.0 

type BatchDeleteTableRowsInput struct {

	//  The list of row ids to delete from the table. You need to specify at least one
	// row id in this list.
	//
	// Note that if one of the row ids provided in the request does not exist in the
	// table, then the request fails and no rows are deleted from the table.
	//
	// This member is required.
	RowIds []string

	// The ID of the table where the rows are being deleted.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook where the rows are being deleted.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	//  The request token for performing the delete action. Request tokens help to
	// identify duplicate requests. If a call times out or fails due to a transient
	// error like a failed network connection, you can retry the call with the same
	// request token. The service ensures that if the first call using that request
	// token is successfully performed, the second call will not perform the action
	// again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type BatchDeleteTableRowsOutput added in v0.31.0 

type BatchDeleteTableRowsOutput struct {

	// The updated workbook cursor after deleting the rows from the table.
	//
	// This member is required.
	WorkbookCursor int64

	//  The list of row ids in the request that could not be deleted from the table.
	// Each element in this list contains one row id from the request that could not be
	// deleted along with the reason why that item could not be deleted.
	FailedBatchItems []types.FailedBatchItem

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

type BatchUpdateTableRowsInput added in v0.31.0 

type BatchUpdateTableRowsInput struct {

	//  The list of rows to update in the table. Each item in this list needs to
	// contain the row id to update along with the map of column id to cell values for
	// each column in that row that needs to be updated. You need to specify at least
	// one row in this list, and for each row, you need to specify at least one column
	// to update.
	//
	// Note that if one of the row or column ids in the request does not exist in the
	// table, then the request fails and no updates are made to the table.
	//
	// This member is required.
	RowsToUpdate []types.UpdateRowData

	// The ID of the table where the rows are being updated.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook where the rows are being updated.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	//  The request token for performing the update action. Request tokens help to
	// identify duplicate requests. If a call times out or fails due to a transient
	// error like a failed network connection, you can retry the call with the same
	// request token. The service ensures that if the first call using that request
	// token is successfully performed, the second call will not perform the action
	// again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type BatchUpdateTableRowsOutput added in v0.31.0 

type BatchUpdateTableRowsOutput struct {

	// The updated workbook cursor after adding the new rows at the end of the table.
	//
	// This member is required.
	WorkbookCursor int64

	//  The list of batch items in the request that could not be updated in the table.
	// Each element in this list contains one item from the request that could not be
	// updated in the table along with the reason why that item could not be updated.
	FailedBatchItems []types.FailedBatchItem

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

type BatchUpsertTableRowsInput added in v0.31.0 

type BatchUpsertTableRowsInput struct {

	//  The list of rows to upsert in the table. Each item in this list needs to have
	// a batch item id to uniquely identify the element in the request, a filter
	// expression to find the rows to update for that element and the cell values to
	// set for each column in the upserted rows. You need to specify at least one item
	// in this list.
	//
	// Note that if one of the filter formulas in the request fails to evaluate
	// because of an error or one of the column ids in any of the rows does not exist
	// in the table, then the request fails and no updates are made to the table.
	//
	// This member is required.
	RowsToUpsert []types.UpsertRowData

	// The ID of the table where the rows are being upserted.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook where the rows are being upserted.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	//  The request token for performing the update action. Request tokens help to
	// identify duplicate requests. If a call times out or fails due to a transient
	// error like a failed network connection, you can retry the call with the same
	// request token. The service ensures that if the first call using that request
	// token is successfully performed, the second call will not perform the action
	// again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	ClientRequestToken *string
	// contains filtered or unexported fields
}

type BatchUpsertTableRowsOutput added in v0.31.0 

type BatchUpsertTableRowsOutput struct {

	//  A map with the batch item id as the key and the result of the upsert operation
	// as the value. The result of the upsert operation specifies whether existing rows
	// were updated or a new row was appended, along with the list of row ids that were
	// affected.
	//
	// This member is required.
	Rows map[string]types.UpsertRowsResult

	// The updated workbook cursor after updating or appending rows in the table.
	//
	// This member is required.
	WorkbookCursor int64

	//  The list of batch items in the request that could not be updated or appended
	// in the table. Each element in this list contains one item from the request that
	// could not be updated in the table along with the reason why that item could not
	// be updated or appended.
	FailedBatchItems []types.FailedBatchItem

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

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) BatchCreateTableRows added in v0.31.0 

func (c *Client) BatchCreateTableRows(ctx context.Context, params *BatchCreateTableRowsInput, optFns ...func(*Options)) (*BatchCreateTableRowsOutput, error)
The BatchCreateTableRows API allows you to create one or more rows at the end

of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

func (*Client) BatchDeleteTableRows added in v0.31.0 

func (c *Client) BatchDeleteTableRows(ctx context.Context, params *BatchDeleteTableRowsInput, optFns ...func(*Options)) (*BatchDeleteTableRowsOutput, error)
The BatchDeleteTableRows API allows you to delete one or more rows from a

table in a workbook. You need to specify the ids of the rows that you want to delete from the table.

func (*Client) BatchUpdateTableRows added in v0.31.0 

func (c *Client) BatchUpdateTableRows(ctx context.Context, params *BatchUpdateTableRowsInput, optFns ...func(*Options)) (*BatchUpdateTableRowsOutput, error)
The BatchUpdateTableRows API allows you to update one or more rows in a table

in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

func (*Client) BatchUpsertTableRows added in v0.31.0 

func (c *Client) BatchUpsertTableRows(ctx context.Context, params *BatchUpsertTableRowsInput, optFns ...func(*Options)) (*BatchUpsertTableRowsOutput, error)
The BatchUpsertTableRows API allows you to upsert one or more rows in a table.

The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

func (*Client) DescribeTableDataImportJob added in v0.31.0 

func (c *Client) DescribeTableDataImportJob(ctx context.Context, params *DescribeTableDataImportJobInput, optFns ...func(*Options)) (*DescribeTableDataImportJobOutput, error)
The DescribeTableDataImportJob API allows you to retrieve the status and

details of a table data import job.

func (*Client) GetScreenData 

func (c *Client) GetScreenData(ctx context.Context, params *GetScreenDataInput, optFns ...func(*Options)) (*GetScreenDataOutput, error)
The GetScreenData API allows retrieval of data from a screen in a Honeycode

app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

func (*Client) InvokeScreenAutomation 

func (c *Client) InvokeScreenAutomation(ctx context.Context, params *InvokeScreenAutomationInput, optFns ...func(*Options)) (*InvokeScreenAutomationOutput, error)
The InvokeScreenAutomation API allows invoking an action defined in a screen

in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

func (*Client) ListTableColumns added in v0.31.0 

func (c *Client) ListTableColumns(ctx context.Context, params *ListTableColumnsInput, optFns ...func(*Options)) (*ListTableColumnsOutput, error)
The ListTableColumns API allows you to retrieve a list of all the columns in a

table in a workbook.

func (*Client) ListTableRows added in v0.31.0 

func (c *Client) ListTableRows(ctx context.Context, params *ListTableRowsInput, optFns ...func(*Options)) (*ListTableRowsOutput, error)
The ListTableRows API allows you to retrieve a list of all the rows in a table

in a workbook.

func (*Client) ListTables added in v0.31.0 

func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error)
The ListTables API allows you to retrieve a list of all the tables in a

workbook.

func (*Client) ListTagsForResource added in v1.9.0 

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

The ListTagsForResource API allows you to return a resource's tags.

func (*Client) Options added in v1.19.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) QueryTableRows added in v0.31.0 

func (c *Client) QueryTableRows(ctx context.Context, params *QueryTableRowsInput, optFns ...func(*Options)) (*QueryTableRowsOutput, error)
The QueryTableRows API allows you to use a filter formula to query for

specific rows in a table.

func (*Client) StartTableDataImportJob added in v0.31.0 

func (c *Client) StartTableDataImportJob(ctx context.Context, params *StartTableDataImportJobInput, optFns ...func(*Options)) (*StartTableDataImportJobOutput, error)
The StartTableDataImportJob API allows you to start an import job on a table.

This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.

func (*Client) TagResource added in v1.9.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
The TagResource API allows you to add tags to an ARN-able resource. Resource

includes workbook, table, screen and screen-automation.

func (*Client) UntagResource added in v1.9.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
The UntagResource API allows you to removes tags from an ARN-able resource.

Resource includes workbook, table, screen and screen-automation.

type DescribeTableDataImportJobInput added in v0.31.0 

type DescribeTableDataImportJobInput struct {

	// The ID of the job that was returned by the StartTableDataImportJob request.
	//
	// If a job with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	JobId *string

	// The ID of the table into which data was imported.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook into which data was imported.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string
	// contains filtered or unexported fields
}

type DescribeTableDataImportJobOutput added in v0.31.0 

type DescribeTableDataImportJobOutput struct {

	//  The metadata about the job that was submitted for import.
	//
	// This member is required.
	JobMetadata *types.TableDataImportJobMetadata

	//  The current status of the import job.
	//
	// This member is required.
	JobStatus types.TableDataImportJobStatus

	//  A message providing more details about the current status of the import job.
	//
	// This member is required.
	Message *string

	//  If job status is failed, error code to understand reason for the failure.
	ErrorCode types.ErrorCode

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

type EndpointParameters added in v1.14.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.14.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.14.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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.14.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.14.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetScreenDataInput 

type GetScreenDataInput struct {

	// The ID of the app that contains the screen.
	//
	// This member is required.
	AppId *string

	// The ID of the screen.
	//
	// This member is required.
	ScreenId *string

	// The ID of the workbook that contains the screen.
	//
	// This member is required.
	WorkbookId *string

	//  The number of results to be returned on a single page. Specify a number
	// between 1 and 100. The maximum value is 100.
	//
	// This parameter is optional. If you don't specify this parameter, the default
	// page size is 100.
	MaxResults *int32

	//  This parameter is optional. If a nextToken is not specified, the API returns
	// the first page of data.
	//
	// Pagination tokens expire after 1 hour. If you use a token that was returned
	// more than an hour back, the API will throw ValidationException.
	NextToken *string

	//  Variables are optional and are needed only if the screen requires them to
	// render correctly. Variables are specified as a map where the key is the name of
	// the variable as defined on the screen. The value is an object which currently
	// has only one property, rawValue, which holds the value of the variable to be
	// passed to the screen.
	Variables map[string]types.VariableValue
	// contains filtered or unexported fields
}

type GetScreenDataOutput 

type GetScreenDataOutput struct {

	// A map of all the rows on the screen keyed by block name.
	//
	// This member is required.
	Results map[string]types.ResultSet

	//  Indicates the cursor of the workbook at which the data returned by this
	// workbook is read. Workbook cursor keeps increasing with every update and the
	// increments are not sequential.
	//
	// This member is required.
	WorkbookCursor int64

	//  Provides the pagination token to load the next page if there are more results
	// matching the request. If a pagination token is not present in the response, it
	// means that all data matching the query has been loaded.
	NextToken *string

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

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 InvokeScreenAutomationInput 

type InvokeScreenAutomationInput struct {

	// The ID of the app that contains the screen automation.
	//
	// This member is required.
	AppId *string

	// The ID of the automation action to be performed.
	//
	// This member is required.
	ScreenAutomationId *string

	// The ID of the screen that contains the screen automation.
	//
	// This member is required.
	ScreenId *string

	// The ID of the workbook that contains the screen automation.
	//
	// This member is required.
	WorkbookId *string

	//  The request token for performing the automation action. Request tokens help to
	// identify duplicate requests. If a call times out or fails due to a transient
	// error like a failed network connection, you can retry the call with the same
	// request token. The service ensures that if the first call using that request
	// token is successfully performed, the second call will return the response of the
	// previous call rather than performing the action again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	ClientRequestToken *string

	//  The row ID for the automation if the automation is defined inside a block with
	// source or list.
	RowId *string

	//  Variables are specified as a map where the key is the name of the variable as
	// defined on the screen. The value is an object which currently has only one
	// property, rawValue, which holds the value of the variable to be passed to the
	// screen. Any variables defined in a screen are required to be passed in the call.
	Variables map[string]types.VariableValue
	// contains filtered or unexported fields
}

type InvokeScreenAutomationOutput 

type InvokeScreenAutomationOutput struct {

	// The updated workbook cursor after performing the automation action.
	//
	// This member is required.
	WorkbookCursor int64

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

type ListTableColumnsAPIClient added in v0.31.0 

type ListTableColumnsAPIClient interface {
	ListTableColumns(context.Context, *ListTableColumnsInput, ...func(*Options)) (*ListTableColumnsOutput, error)
}

ListTableColumnsAPIClient is a client that implements the ListTableColumns operation.

type ListTableColumnsInput added in v0.31.0 

type ListTableColumnsInput struct {

	// The ID of the table whose columns are being retrieved.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook that contains the table whose columns are being
	// retrieved.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	//  This parameter is optional. If a nextToken is not specified, the API returns
	// the first page of data.
	//
	// Pagination tokens expire after 1 hour. If you use a token that was returned
	// more than an hour back, the API will throw ValidationException.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTableColumnsOutput added in v0.31.0 

type ListTableColumnsOutput struct {

	//  The list of columns in the table.
	//
	// This member is required.
	TableColumns []types.TableColumn

	//  Provides the pagination token to load the next page if there are more results
	// matching the request. If a pagination token is not present in the response, it
	// means that all data matching the request has been loaded.
	NextToken *string

	//  Indicates the cursor of the workbook at which the data returned by this
	// request is read. Workbook cursor keeps increasing with every update and the
	// increments are not sequential.
	WorkbookCursor int64

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

type ListTableColumnsPaginator added in v0.31.0 

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

ListTableColumnsPaginator is a paginator for ListTableColumns

func NewListTableColumnsPaginator added in v0.31.0 

func NewListTableColumnsPaginator(client ListTableColumnsAPIClient, params *ListTableColumnsInput, optFns ...func(*ListTableColumnsPaginatorOptions)) *ListTableColumnsPaginator

NewListTableColumnsPaginator returns a new ListTableColumnsPaginator

func (*ListTableColumnsPaginator) HasMorePages added in v0.31.0 

func (p *ListTableColumnsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableColumnsPaginator) NextPage added in v0.31.0 

func (p *ListTableColumnsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableColumnsOutput, error)

NextPage retrieves the next ListTableColumns page.

type ListTableColumnsPaginatorOptions added in v0.31.0 

type ListTableColumnsPaginatorOptions struct {
	// 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
}

ListTableColumnsPaginatorOptions is the paginator options for ListTableColumns

type ListTableRowsAPIClient added in v0.31.0 

type ListTableRowsAPIClient interface {
	ListTableRows(context.Context, *ListTableRowsInput, ...func(*Options)) (*ListTableRowsOutput, error)
}

ListTableRowsAPIClient is a client that implements the ListTableRows operation.

type ListTableRowsInput added in v0.31.0 

type ListTableRowsInput struct {

	// The ID of the table whose rows are being retrieved.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook that contains the table whose rows are being retrieved.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	// The maximum number of rows to return in each page of the results.
	MaxResults *int32

	//  This parameter is optional. If a nextToken is not specified, the API returns
	// the first page of data.
	//
	// Pagination tokens expire after 1 hour. If you use a token that was returned
	// more than an hour back, the API will throw ValidationException.
	NextToken *string

	//  This parameter is optional. If one or more row ids are specified in this list,
	// then only the specified row ids are returned in the result. If no row ids are
	// specified here, then all the rows in the table are returned.
	RowIds []string
	// contains filtered or unexported fields
}

type ListTableRowsOutput added in v0.31.0 

type ListTableRowsOutput struct {

	//  The list of columns in the table whose row data is returned in the result.
	//
	// This member is required.
	ColumnIds []string

	//  The list of rows in the table. Note that this result is paginated, so this
	// list contains a maximum of 100 rows.
	//
	// This member is required.
	Rows []types.TableRow

	//  Indicates the cursor of the workbook at which the data returned by this
	// request is read. Workbook cursor keeps increasing with every update and the
	// increments are not sequential.
	//
	// This member is required.
	WorkbookCursor int64

	//  Provides the pagination token to load the next page if there are more results
	// matching the request. If a pagination token is not present in the response, it
	// means that all data matching the request has been loaded.
	NextToken *string

	//  The list of row ids included in the request that were not found in the table.
	RowIdsNotFound []string

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

type ListTableRowsPaginator added in v0.31.0 

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

ListTableRowsPaginator is a paginator for ListTableRows

func NewListTableRowsPaginator added in v0.31.0 

func NewListTableRowsPaginator(client ListTableRowsAPIClient, params *ListTableRowsInput, optFns ...func(*ListTableRowsPaginatorOptions)) *ListTableRowsPaginator

NewListTableRowsPaginator returns a new ListTableRowsPaginator

func (*ListTableRowsPaginator) HasMorePages added in v0.31.0 

func (p *ListTableRowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableRowsPaginator) NextPage added in v0.31.0 

func (p *ListTableRowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableRowsOutput, error)

NextPage retrieves the next ListTableRows page.

type ListTableRowsPaginatorOptions added in v0.31.0 

type ListTableRowsPaginatorOptions struct {
	// The maximum number of rows to return in each page of the results.
	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
}

ListTableRowsPaginatorOptions is the paginator options for ListTableRows

type ListTablesAPIClient added in v0.31.0 

type ListTablesAPIClient interface {
	ListTables(context.Context, *ListTablesInput, ...func(*Options)) (*ListTablesOutput, error)
}

ListTablesAPIClient is a client that implements the ListTables operation.

type ListTablesInput added in v0.31.0 

type ListTablesInput struct {

	// The ID of the workbook whose tables are being retrieved.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	// The maximum number of tables to return in each page of the results.
	MaxResults *int32

	//  This parameter is optional. If a nextToken is not specified, the API returns
	// the first page of data.
	//
	// Pagination tokens expire after 1 hour. If you use a token that was returned
	// more than an hour back, the API will throw ValidationException.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTablesOutput added in v0.31.0 

type ListTablesOutput struct {

	//  The list of tables in the workbook.
	//
	// This member is required.
	Tables []types.Table

	//  Provides the pagination token to load the next page if there are more results
	// matching the request. If a pagination token is not present in the response, it
	// means that all data matching the request has been loaded.
	NextToken *string

	//  Indicates the cursor of the workbook at which the data returned by this
	// request is read. Workbook cursor keeps increasing with every update and the
	// increments are not sequential.
	WorkbookCursor int64

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

type ListTablesPaginator added in v0.31.0 

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

ListTablesPaginator is a paginator for ListTables

func NewListTablesPaginator added in v0.31.0 

func NewListTablesPaginator(client ListTablesAPIClient, params *ListTablesInput, optFns ...func(*ListTablesPaginatorOptions)) *ListTablesPaginator

NewListTablesPaginator returns a new ListTablesPaginator

func (*ListTablesPaginator) HasMorePages added in v0.31.0 

func (p *ListTablesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTablesPaginator) NextPage added in v0.31.0 

func (p *ListTablesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTablesOutput, error)

NextPage retrieves the next ListTables page.

type ListTablesPaginatorOptions added in v0.31.0 

type ListTablesPaginatorOptions struct {
	// The maximum number of tables to return in each page of the results.
	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
}

ListTablesPaginatorOptions is the paginator options for ListTables

type ListTagsForResourceInput added in v1.9.0 

type ListTagsForResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.9.0 

type ListTagsForResourceOutput struct {

	// The resource's tags.
	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 operation. 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.
	//
	// 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.18.2 

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

type QueryTableRowsAPIClient added in v0.31.0 

type QueryTableRowsAPIClient interface {
	QueryTableRows(context.Context, *QueryTableRowsInput, ...func(*Options)) (*QueryTableRowsOutput, error)
}

QueryTableRowsAPIClient is a client that implements the QueryTableRows operation.

type QueryTableRowsInput added in v0.31.0 

type QueryTableRowsInput struct {

	// An object that represents a filter formula along with the id of the context row
	// under which the filter function needs to evaluate.
	//
	// This member is required.
	FilterFormula *types.Filter

	// The ID of the table whose rows are being queried.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	TableId *string

	// The ID of the workbook whose table rows are being queried.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string

	// The maximum number of rows to return in each page of the results.
	MaxResults *int32

	//  This parameter is optional. If a nextToken is not specified, the API returns
	// the first page of data.
	//
	// Pagination tokens expire after 1 hour. If you use a token that was returned
	// more than an hour back, the API will throw ValidationException.
	NextToken *string
	// contains filtered or unexported fields
}

type QueryTableRowsOutput added in v0.31.0 

type QueryTableRowsOutput struct {

	//  The list of columns in the table whose row data is returned in the result.
	//
	// This member is required.
	ColumnIds []string

	//  The list of rows in the table that match the query filter.
	//
	// This member is required.
	Rows []types.TableRow

	//  Indicates the cursor of the workbook at which the data returned by this
	// request is read. Workbook cursor keeps increasing with every update and the
	// increments are not sequential.
	//
	// This member is required.
	WorkbookCursor int64

	//  Provides the pagination token to load the next page if there are more results
	// matching the request. If a pagination token is not present in the response, it
	// means that all data matching the request has been loaded.
	NextToken *string

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

type QueryTableRowsPaginator added in v0.31.0 

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

QueryTableRowsPaginator is a paginator for QueryTableRows

func NewQueryTableRowsPaginator added in v0.31.0 

func NewQueryTableRowsPaginator(client QueryTableRowsAPIClient, params *QueryTableRowsInput, optFns ...func(*QueryTableRowsPaginatorOptions)) *QueryTableRowsPaginator

NewQueryTableRowsPaginator returns a new QueryTableRowsPaginator

func (*QueryTableRowsPaginator) HasMorePages added in v0.31.0 

func (p *QueryTableRowsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*QueryTableRowsPaginator) NextPage added in v0.31.0 

func (p *QueryTableRowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*QueryTableRowsOutput, error)

NextPage retrieves the next QueryTableRows page.

type QueryTableRowsPaginatorOptions added in v0.31.0 

type QueryTableRowsPaginatorOptions struct {
	// The maximum number of rows to return in each page of the results.
	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
}

QueryTableRowsPaginatorOptions is the paginator options for QueryTableRows

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 StartTableDataImportJobInput added in v0.31.0 

type StartTableDataImportJobInput struct {

	//  The request token for performing the update action. Request tokens help to
	// identify duplicate requests. If a call times out or fails due to a transient
	// error like a failed network connection, you can retry the call with the same
	// request token. The service ensures that if the first call using that request
	// token is successfully performed, the second call will not perform the action
	// again.
	//
	// Note that request tokens are valid only for a few minutes. You cannot use
	// request tokens to dedupe requests spanning hours or days.
	//
	// This member is required.
	ClientRequestToken *string

	//  The format of the data that is being imported. Currently the only option
	// supported is "DELIMITED_TEXT".
	//
	// This member is required.
	DataFormat types.ImportSourceDataFormat

	//  The source of the data that is being imported. The size of source must be no
	// larger than 100 MB. Source must have no more than 100,000 cells and no more than
	// 1,000 rows.
	//
	// This member is required.
	DataSource *types.ImportDataSource

	// The ID of the table where the rows are being imported.
	//
	// If a table with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	DestinationTableId *string

	//  The options for customizing this import request.
	//
	// This member is required.
	ImportOptions *types.ImportOptions

	// The ID of the workbook where the rows are being imported.
	//
	// If a workbook with the specified id could not be found, this API throws
	// ResourceNotFoundException.
	//
	// This member is required.
	WorkbookId *string
	// contains filtered or unexported fields
}

type StartTableDataImportJobOutput added in v0.31.0 

type StartTableDataImportJobOutput struct {

	//  The id that is assigned to this import job. Future requests to find out the
	// status of this import job need to send this id in the appropriate parameter in
	// the request.
	//
	// This member is required.
	JobId *string

	//  The status of the import job immediately after submitting the request.
	//
	// This member is required.
	JobStatus types.TableDataImportJobStatus

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

type TagResourceInput added in v1.9.0 

type TagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

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

type TagResourceOutput added in v1.9.0 

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

type UntagResourceInput added in v1.9.0 

type UntagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// A list of tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.9.0 

type UntagResourceOutput struct {
	// 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.