package honeycode
import "github.com/aws/aws-sdk-go-v2/service/honeycode"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) GetScreenData(ctx context.Context, params *GetScreenDataInput, optFns ...func(*Options)) (*GetScreenDataOutput, error)
- func (c *Client) InvokeScreenAutomation(ctx context.Context, params *InvokeScreenAutomationInput, optFns ...func(*Options)) (*InvokeScreenAutomationOutput, error)
- type EndpointResolver
- type EndpointResolverFunc
- type GetScreenDataInput
- type GetScreenDataOutput
- type HTTPClient
- type HTTPSignerV4
- type InvokeScreenAutomationInput
- type InvokeScreenAutomationOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
Constants ¶
const ServiceAPIVersion = "2020-03-01"
const ServiceID = "Honeycode"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
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.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
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.
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type GetScreenDataInput ¶
type GetScreenDataInput struct { // 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 // 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 // The ID of the app that contains the screem. // // This member is required. AppId *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 // 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 }
type GetScreenDataOutput ¶
type GetScreenDataOutput struct { // 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 // 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 // A map of all the rows on the screen keyed by block name. // // This member is required. Results map[string]*types.ResultSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type InvokeScreenAutomationInput ¶
type InvokeScreenAutomationInput struct { // The ID of the automation action to be performed. // // This member is required. ScreenAutomationId *string // The ID of the app that contains the screen automation. // // This member is required. AppId *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 ID of the workbook that contains the screen automation. // // This member is required. WorkbookId *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 // The row ID for the automation if the automation is defined inside a block with // source or list. RowId *string // The ID of the screen that contains the screen automation. // // This member is required. ScreenId *string }
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 }
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 credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
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 ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
Source Files ¶
api_client.go api_op_GetScreenData.go api_op_InvokeScreenAutomation.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- windows/amd64
- Imports
- 24 packages
- Last checked
- now –
Tools for package owners.