honeycode

package
v1.33.8 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2020 License: Apache-2.0 Imports: 9 Imported by: 13

Documentation

Overview

Package honeycode provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01 for more information on this service.

See honeycode package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/honeycode/

Using the Client

To contact Amazon Honeycode with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Honeycode client Honeycode for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/honeycode/#New

Index

Constants

View Source 
const (
	// FormatAuto is a Format enum value
	FormatAuto = "AUTO"

	// FormatNumber is a Format enum value
	FormatNumber = "NUMBER"

	// FormatCurrency is a Format enum value
	FormatCurrency = "CURRENCY"

	// FormatDate is a Format enum value
	FormatDate = "DATE"

	// FormatTime is a Format enum value
	FormatTime = "TIME"

	// FormatDateTime is a Format enum value
	FormatDateTime = "DATE_TIME"

	// FormatPercentage is a Format enum value
	FormatPercentage = "PERCENTAGE"

	// FormatText is a Format enum value
	FormatText = "TEXT"

	// FormatAccounting is a Format enum value
	FormatAccounting = "ACCOUNTING"

	// FormatContact is a Format enum value
	FormatContact = "CONTACT"

	// FormatRowlink is a Format enum value
	FormatRowlink = "ROWLINK"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action. Check that the
	// workbook is owned by you and your IAM policy allows access to the screen/automation
	// in the request.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAutomationExecutionException for service response error code
	// "AutomationExecutionException".
	//
	// The automation execution did not end successfully.
	ErrCodeAutomationExecutionException = "AutomationExecutionException"

	// ErrCodeAutomationExecutionTimeoutException for service response error code
	// "AutomationExecutionTimeoutException".
	//
	// The automation execution timed out.
	ErrCodeAutomationExecutionTimeoutException = "AutomationExecutionTimeoutException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// There were unexpected errors from the server.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeRequestTimeoutException for service response error code
	// "RequestTimeoutException".
	//
	// The request timed out.
	ErrCodeRequestTimeoutException = "RequestTimeoutException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A Workbook, App, Screen or Screen Automation was not found with the given
	// ID.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Remote service is unreachable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Tps(transactions per second) rate reached.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Request is invalid. The message in the response contains details on why the
	// request is invalid.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Honeycode" // Name of service.
	EndpointsID = "honeycode" // ID to lookup a service endpoint with.
	ServiceID   = "Honeycode" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation

type AutomationExecutionException 

type AutomationExecutionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The automation execution did not end successfully.

func (*AutomationExecutionException) Code 

func (s *AutomationExecutionException) Code() string

Code returns the exception type name.

func (*AutomationExecutionException) Error 

func (s *AutomationExecutionException) Error() string

func (AutomationExecutionException) GoString 

func (s AutomationExecutionException) GoString() string

GoString returns the string representation

func (*AutomationExecutionException) Message 

func (s *AutomationExecutionException) Message() string

Message returns the exception's message.

func (*AutomationExecutionException) OrigErr 

func (s *AutomationExecutionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AutomationExecutionException) RequestID 

func (s *AutomationExecutionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AutomationExecutionException) StatusCode 

func (s *AutomationExecutionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AutomationExecutionException) String 

func (s AutomationExecutionException) String() string

String returns the string representation

type AutomationExecutionTimeoutException 

type AutomationExecutionTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The automation execution timed out.

func (*AutomationExecutionTimeoutException) Code 

func (s *AutomationExecutionTimeoutException) Code() string

Code returns the exception type name.

func (*AutomationExecutionTimeoutException) Error 

func (s *AutomationExecutionTimeoutException) Error() string

func (AutomationExecutionTimeoutException) GoString 

func (s AutomationExecutionTimeoutException) GoString() string

GoString returns the string representation

func (*AutomationExecutionTimeoutException) Message 

func (s *AutomationExecutionTimeoutException) Message() string

Message returns the exception's message.

func (*AutomationExecutionTimeoutException) OrigErr 

func (s *AutomationExecutionTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AutomationExecutionTimeoutException) RequestID 

func (s *AutomationExecutionTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AutomationExecutionTimeoutException) StatusCode 

func (s *AutomationExecutionTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AutomationExecutionTimeoutException) String 

func (s AutomationExecutionTimeoutException) String() string

String returns the string representation

type ColumnMetadata 

type ColumnMetadata struct {

	// The format of the column.
	//
	// Format is a required field
	Format *string `locationName:"format" type:"string" required:"true" enum:"Format"`

	// The name of the column.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Metadata for column in the table.

func (ColumnMetadata) GoString 

func (s ColumnMetadata) GoString() string

GoString returns the string representation

func (*ColumnMetadata) SetFormat 

func (s *ColumnMetadata) SetFormat(v string) *ColumnMetadata

SetFormat sets the Format field's value.

func (*ColumnMetadata) SetName 

func (s *ColumnMetadata) SetName(v string) *ColumnMetadata

SetName sets the Name field's value.

func (ColumnMetadata) String 

func (s ColumnMetadata) String() string

String returns the string representation

type DataItem 

type DataItem struct {

	// The formatted value of the data. e.g. John Smith.
	FormattedValue *string `locationName:"formattedValue" type:"string"`

	// The overrideFormat is optional and is specified only if a particular row
	// of data has a different format for the data than the default format defined
	// on the screen or the table.
	OverrideFormat *string `locationName:"overrideFormat" type:"string" enum:"Format"`

	// The raw value of the data. e.g. jsmith@example.com
	RawValue *string `locationName:"rawValue" type:"string"`
	// contains filtered or unexported fields
}

The data in a particular data cell defined on the screen.

func (DataItem) GoString 

func (s DataItem) GoString() string

GoString returns the string representation

func (*DataItem) SetFormattedValue 

func (s *DataItem) SetFormattedValue(v string) *DataItem

SetFormattedValue sets the FormattedValue field's value.

func (*DataItem) SetOverrideFormat 

func (s *DataItem) SetOverrideFormat(v string) *DataItem

SetOverrideFormat sets the OverrideFormat field's value.

func (*DataItem) SetRawValue 

func (s *DataItem) SetRawValue(v string) *DataItem

SetRawValue sets the RawValue field's value.

func (DataItem) String 

func (s DataItem) String() string

String returns the string representation

type GetScreenDataInput 

type GetScreenDataInput struct {

	// The ID of the app that contains the screem.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// The ID of the screen.
	//
	// ScreenId is a required field
	ScreenId *string `locationName:"screenId" type:"string" required:"true"`

	// 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]*VariableValue `locationName:"variables" type:"map" sensitive:"true"`

	// The ID of the workbook that contains the screen.
	//
	// WorkbookId is a required field
	WorkbookId *string `locationName:"workbookId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetScreenDataInput) GoString 

func (s GetScreenDataInput) GoString() string

GoString returns the string representation

func (*GetScreenDataInput) SetAppId 

func (s *GetScreenDataInput) SetAppId(v string) *GetScreenDataInput

SetAppId sets the AppId field's value.

func (*GetScreenDataInput) SetMaxResults 

func (s *GetScreenDataInput) SetMaxResults(v int64) *GetScreenDataInput

SetMaxResults sets the MaxResults field's value.

func (*GetScreenDataInput) SetNextToken 

func (s *GetScreenDataInput) SetNextToken(v string) *GetScreenDataInput

SetNextToken sets the NextToken field's value.

func (*GetScreenDataInput) SetScreenId 

func (s *GetScreenDataInput) SetScreenId(v string) *GetScreenDataInput

SetScreenId sets the ScreenId field's value.

func (*GetScreenDataInput) SetVariables 

func (s *GetScreenDataInput) SetVariables(v map[string]*VariableValue) *GetScreenDataInput

SetVariables sets the Variables field's value.

func (*GetScreenDataInput) SetWorkbookId 

func (s *GetScreenDataInput) SetWorkbookId(v string) *GetScreenDataInput

SetWorkbookId sets the WorkbookId field's value.

func (GetScreenDataInput) String 

func (s GetScreenDataInput) String() string

String returns the string representation

func (*GetScreenDataInput) Validate 

func (s *GetScreenDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `locationName:"nextToken" min:"1" type:"string"`

	// A map of all the rows on the screen keyed by block name.
	//
	// Results is a required field
	Results map[string]*ResultSet `locationName:"results" type:"map" required:"true"`

	// 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.
	//
	// WorkbookCursor is a required field
	WorkbookCursor *int64 `locationName:"workbookCursor" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (GetScreenDataOutput) GoString 

func (s GetScreenDataOutput) GoString() string

GoString returns the string representation

func (*GetScreenDataOutput) SetNextToken 

func (s *GetScreenDataOutput) SetNextToken(v string) *GetScreenDataOutput

SetNextToken sets the NextToken field's value.

func (*GetScreenDataOutput) SetResults 

func (s *GetScreenDataOutput) SetResults(v map[string]*ResultSet) *GetScreenDataOutput

SetResults sets the Results field's value.

func (*GetScreenDataOutput) SetWorkbookCursor 

func (s *GetScreenDataOutput) SetWorkbookCursor(v int64) *GetScreenDataOutput

SetWorkbookCursor sets the WorkbookCursor field's value.

func (GetScreenDataOutput) String 

func (s GetScreenDataOutput) String() string

String returns the string representation

type Honeycode 

type Honeycode struct {
	*client.Client
}

Honeycode provides the API operation methods for making requests to Amazon Honeycode. See this package's package overview docs for details on the service.

Honeycode methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Honeycode

New creates a new instance of the Honeycode client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Honeycode client from just a session.
svc := honeycode.New(mySession)

// Create a Honeycode client with additional configuration
svc := honeycode.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Honeycode) GetScreenData 

func (c *Honeycode) GetScreenData(input *GetScreenDataInput) (*GetScreenDataOutput, error)

GetScreenData API operation for Amazon Honeycode.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Honeycode's API operation GetScreenData for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

  • InternalServerException There were unexpected errors from the server.

  • RequestTimeoutException The request timed out.

  • ResourceNotFoundException A Workbook, App, Screen or Screen Automation was not found with the given ID.

  • ServiceUnavailableException Remote service is unreachable.

  • ThrottlingException Tps(transactions per second) rate reached.

  • ValidationException Request is invalid. The message in the response contains details on why the request is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenData

func (*Honeycode) GetScreenDataRequest 

func (c *Honeycode) GetScreenDataRequest(input *GetScreenDataInput) (req *request.Request, output *GetScreenDataOutput)

GetScreenDataRequest generates a "aws/request.Request" representing the client's request for the GetScreenData operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetScreenData for more information on using the GetScreenData API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetScreenDataRequest method.
req, resp := client.GetScreenDataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenData

func (*Honeycode) GetScreenDataWithContext 

func (c *Honeycode) GetScreenDataWithContext(ctx aws.Context, input *GetScreenDataInput, opts ...request.Option) (*GetScreenDataOutput, error)

GetScreenDataWithContext is the same as GetScreenData with the addition of the ability to pass a context and additional request options.

See GetScreenData for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Honeycode) InvokeScreenAutomation 

func (c *Honeycode) InvokeScreenAutomation(input *InvokeScreenAutomationInput) (*InvokeScreenAutomationOutput, error)

InvokeScreenAutomation API operation for Amazon Honeycode.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Honeycode's API operation InvokeScreenAutomation for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

  • InternalServerException There were unexpected errors from the server.

  • ResourceNotFoundException A Workbook, App, Screen or Screen Automation was not found with the given ID.

  • ValidationException Request is invalid. The message in the response contains details on why the request is invalid.

  • ThrottlingException Tps(transactions per second) rate reached.

  • ServiceUnavailableException Remote service is unreachable.

  • AutomationExecutionException The automation execution did not end successfully.

  • AutomationExecutionTimeoutException The automation execution timed out.

  • RequestTimeoutException The request timed out.

See also, https://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomation

func (*Honeycode) InvokeScreenAutomationRequest 

func (c *Honeycode) InvokeScreenAutomationRequest(input *InvokeScreenAutomationInput) (req *request.Request, output *InvokeScreenAutomationOutput)

InvokeScreenAutomationRequest generates a "aws/request.Request" representing the client's request for the InvokeScreenAutomation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InvokeScreenAutomation for more information on using the InvokeScreenAutomation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the InvokeScreenAutomationRequest method.
req, resp := client.InvokeScreenAutomationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomation

func (*Honeycode) InvokeScreenAutomationWithContext 

func (c *Honeycode) InvokeScreenAutomationWithContext(ctx aws.Context, input *InvokeScreenAutomationInput, opts ...request.Option) (*InvokeScreenAutomationOutput, error)

InvokeScreenAutomationWithContext is the same as InvokeScreenAutomation with the addition of the ability to pass a context and additional request options.

See InvokeScreenAutomation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There were unexpected errors from the server.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation

type InvokeScreenAutomationInput 

type InvokeScreenAutomationInput struct {

	// The ID of the app that contains the screen automation.
	//
	// AppId is a required field
	AppId *string `location:"uri" locationName:"appId" type:"string" required:"true"`

	// 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 `locationName:"clientRequestToken" min:"32" type:"string"`

	// The row ID for the automation if the automation is defined inside a block
	// with source or list.
	RowId *string `locationName:"rowId" type:"string"`

	// The ID of the automation action to be performed.
	//
	// ScreenAutomationId is a required field
	ScreenAutomationId *string `location:"uri" locationName:"automationId" type:"string" required:"true"`

	// The ID of the screen that contains the screen automation.
	//
	// ScreenId is a required field
	ScreenId *string `location:"uri" locationName:"screenId" type:"string" required:"true"`

	// 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]*VariableValue `locationName:"variables" type:"map" sensitive:"true"`

	// The ID of the workbook that contains the screen automation.
	//
	// WorkbookId is a required field
	WorkbookId *string `location:"uri" locationName:"workbookId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InvokeScreenAutomationInput) GoString 

func (s InvokeScreenAutomationInput) GoString() string

GoString returns the string representation

func (*InvokeScreenAutomationInput) SetAppId 

func (s *InvokeScreenAutomationInput) SetAppId(v string) *InvokeScreenAutomationInput

SetAppId sets the AppId field's value.

func (*InvokeScreenAutomationInput) SetClientRequestToken 

func (s *InvokeScreenAutomationInput) SetClientRequestToken(v string) *InvokeScreenAutomationInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*InvokeScreenAutomationInput) SetRowId 

func (s *InvokeScreenAutomationInput) SetRowId(v string) *InvokeScreenAutomationInput

SetRowId sets the RowId field's value.

func (*InvokeScreenAutomationInput) SetScreenAutomationId 

func (s *InvokeScreenAutomationInput) SetScreenAutomationId(v string) *InvokeScreenAutomationInput

SetScreenAutomationId sets the ScreenAutomationId field's value.

func (*InvokeScreenAutomationInput) SetScreenId 

func (s *InvokeScreenAutomationInput) SetScreenId(v string) *InvokeScreenAutomationInput

SetScreenId sets the ScreenId field's value.

func (*InvokeScreenAutomationInput) SetVariables 

func (s *InvokeScreenAutomationInput) SetVariables(v map[string]*VariableValue) *InvokeScreenAutomationInput

SetVariables sets the Variables field's value.

func (*InvokeScreenAutomationInput) SetWorkbookId 

func (s *InvokeScreenAutomationInput) SetWorkbookId(v string) *InvokeScreenAutomationInput

SetWorkbookId sets the WorkbookId field's value.

func (InvokeScreenAutomationInput) String 

func (s InvokeScreenAutomationInput) String() string

String returns the string representation

func (*InvokeScreenAutomationInput) Validate 

func (s *InvokeScreenAutomationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvokeScreenAutomationOutput 

type InvokeScreenAutomationOutput struct {

	// The updated workbook cursor after performing the automation action.
	//
	// WorkbookCursor is a required field
	WorkbookCursor *int64 `locationName:"workbookCursor" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (InvokeScreenAutomationOutput) GoString 

func (s InvokeScreenAutomationOutput) GoString() string

GoString returns the string representation

func (*InvokeScreenAutomationOutput) SetWorkbookCursor 

func (s *InvokeScreenAutomationOutput) SetWorkbookCursor(v int64) *InvokeScreenAutomationOutput

SetWorkbookCursor sets the WorkbookCursor field's value.

func (InvokeScreenAutomationOutput) String 

func (s InvokeScreenAutomationOutput) String() string

String returns the string representation

type RequestTimeoutException 

type RequestTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request timed out.

func (*RequestTimeoutException) Code 

func (s *RequestTimeoutException) Code() string

Code returns the exception type name.

func (*RequestTimeoutException) Error 

func (s *RequestTimeoutException) Error() string

func (RequestTimeoutException) GoString 

func (s RequestTimeoutException) GoString() string

GoString returns the string representation

func (*RequestTimeoutException) Message 

func (s *RequestTimeoutException) Message() string

Message returns the exception's message.

func (*RequestTimeoutException) OrigErr 

func (s *RequestTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestTimeoutException) RequestID 

func (s *RequestTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestTimeoutException) StatusCode 

func (s *RequestTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestTimeoutException) String 

func (s RequestTimeoutException) String() string

String returns the string representation

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A Workbook, App, Screen or Screen Automation was not found with the given ID.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResultRow 

type ResultRow struct {

	// List of all the data cells in a row.
	//
	// DataItems is a required field
	DataItems []*DataItem `locationName:"dataItems" type:"list" required:"true"`

	// The ID for a particular row.
	RowId *string `locationName:"rowId" type:"string"`
	// contains filtered or unexported fields
}

A single row in the ResultSet.

func (ResultRow) GoString 

func (s ResultRow) GoString() string

GoString returns the string representation

func (*ResultRow) SetDataItems 

func (s *ResultRow) SetDataItems(v []*DataItem) *ResultRow

SetDataItems sets the DataItems field's value.

func (*ResultRow) SetRowId 

func (s *ResultRow) SetRowId(v string) *ResultRow

SetRowId sets the RowId field's value.

func (ResultRow) String 

func (s ResultRow) String() string

String returns the string representation

type ResultSet 

type ResultSet struct {

	// List of headers for all the data cells in the block. The header identifies
	// the name and default format of the data cell. Data cells appear in the same
	// order in all rows as defined in the header. The names and formats are not
	// repeated in the rows. If a particular row does not have a value for a data
	// cell, a blank value is used.
	//
	// For example, a task list that displays the task name, due date and assigned
	// person might have headers [ { "name": "Task Name"}, {"name": "Due Date",
	// "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row
	// in the result will have the task name as the first item, due date as the
	// second item and assigned person as the third item. If a particular task does
	// not have a due date, that row will still have a blank value in the second
	// element and the assigned person will still be in the third element.
	//
	// Headers is a required field
	Headers []*ColumnMetadata `locationName:"headers" type:"list" required:"true"`

	// List of rows returned by the request. Each row has a row Id and a list of
	// data cells in that row. The data cells will be present in the same order
	// as they are defined in the header.
	//
	// Rows is a required field
	Rows []*ResultRow `locationName:"rows" type:"list" required:"true"`
	// contains filtered or unexported fields
}

ResultSet contains the results of the request for a single block or list defined on the screen.

func (ResultSet) GoString 

func (s ResultSet) GoString() string

GoString returns the string representation

func (*ResultSet) SetHeaders 

func (s *ResultSet) SetHeaders(v []*ColumnMetadata) *ResultSet

SetHeaders sets the Headers field's value.

func (*ResultSet) SetRows 

func (s *ResultSet) SetRows(v []*ResultRow) *ResultSet

SetRows sets the Rows field's value.

func (ResultSet) String 

func (s ResultSet) String() string

String returns the string representation

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Remote service is unreachable.

func (*ServiceUnavailableException) Code 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String 

func (s ServiceUnavailableException) String() string

String returns the string representation

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Tps(transactions per second) rate reached.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Request is invalid. The message in the response contains details on why the request is invalid.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation

type VariableValue 

type VariableValue struct {

	// Raw value of the variable.
	//
	// RawValue is a required field
	RawValue *string `locationName:"rawValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input variables to the app to be used by the InvokeScreenAutomation action request.

func (VariableValue) GoString 

func (s VariableValue) GoString() string

GoString returns the string representation

func (*VariableValue) SetRawValue 

func (s *VariableValue) SetRawValue(v string) *VariableValue

SetRawValue sets the RawValue field's value.

func (VariableValue) String 

func (s VariableValue) String() string

String returns the string representation

func (*VariableValue) Validate 

func (s *VariableValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package honeycodeiface provides an interface to enable mocking the Amazon Honeycode service client for testing your code.
 Package honeycodeiface provides an interface to enable mocking the Amazon Honeycode service client for testing your code.

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.