types

package
v1.3.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Column 

type Column struct {

	// The description for a column.
	Description *string

	// The column name.
	Name *string

	// The kind of data a column stores.
	Type *string
	// contains filtered or unexported fields
}

Includes basic information for a data column such as its description, name, and type.

type CompressionOption 

type CompressionOption string
const (
	CompressionOptionGzip    CompressionOption = "GZIP"
	CompressionOptionParquet CompressionOption = "PARQUET"
)

Enum values for CompressionOption

func (CompressionOption) Values 

func (CompressionOption) Values() []CompressionOption

Values returns all known values for CompressionOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataQuery 

type DataQuery struct {

	// The query statement.
	//
	// This member is required.
	QueryStatement *string

	// The table configuration.
	TableConfigurations map[string]map[string]string
	// contains filtered or unexported fields
}

The SQL query of column selections and row filters from the data table you want.

type DestinationConfigurations 

type DestinationConfigurations struct {

	// An object that describes the destination of the data exports file.
	//
	// This member is required.
	S3Destination *S3Destination
	// contains filtered or unexported fields
}

The destinations used for data exports.

type ExecutionReference 

type ExecutionReference struct {

	// The ID for this specific execution.
	//
	// This member is required.
	ExecutionId *string

	// The status of this specific execution.
	//
	// This member is required.
	ExecutionStatus *ExecutionStatus
	// contains filtered or unexported fields
}

The reference for the data export update.

type ExecutionStatus 

type ExecutionStatus struct {

	// The time when the execution was completed.
	CompletedAt *time.Time

	// The time when the execution was created.
	CreatedAt *time.Time

	// The time when the execution was last updated.
	LastUpdatedAt *time.Time

	// The code for the status of the execution.
	StatusCode ExecutionStatusCode

	// The reason for the failed status.
	StatusReason ExecutionStatusReason
	// contains filtered or unexported fields
}

The status of the execution.

type ExecutionStatusCode 

type ExecutionStatusCode string
const (
	ExecutionStatusCodeInitiationInProcess ExecutionStatusCode = "INITIATION_IN_PROCESS"
	ExecutionStatusCodeQueryQueued         ExecutionStatusCode = "QUERY_QUEUED"
	ExecutionStatusCodeQueryInProcess      ExecutionStatusCode = "QUERY_IN_PROCESS"
	ExecutionStatusCodeQueryFailure        ExecutionStatusCode = "QUERY_FAILURE"
	ExecutionStatusCodeDeliveryInProcess   ExecutionStatusCode = "DELIVERY_IN_PROCESS"
	ExecutionStatusCodeDeliverySuccess     ExecutionStatusCode = "DELIVERY_SUCCESS"
	ExecutionStatusCodeDeliveryFailure     ExecutionStatusCode = "DELIVERY_FAILURE"
)

Enum values for ExecutionStatusCode

func (ExecutionStatusCode) Values 

func (ExecutionStatusCode) Values() []ExecutionStatusCode

Values returns all known values for ExecutionStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionStatusReason 

type ExecutionStatusReason string
const (
	ExecutionStatusReasonInsufficientPermission ExecutionStatusReason = "INSUFFICIENT_PERMISSION"
	ExecutionStatusReasonBillOwnerChanged       ExecutionStatusReason = "BILL_OWNER_CHANGED"
	ExecutionStatusReasonInternalFailure        ExecutionStatusReason = "INTERNAL_FAILURE"
)

Enum values for ExecutionStatusReason

func (ExecutionStatusReason) Values 

func (ExecutionStatusReason) Values() []ExecutionStatusReason

Values returns all known values for ExecutionStatusReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Export 

type Export struct {

	// The data query for this specific data export.
	//
	// This member is required.
	DataQuery *DataQuery

	// The destination configuration for this specific data export.
	//
	// This member is required.
	DestinationConfigurations *DestinationConfigurations

	// The name of this specific data export.
	//
	// This member is required.
	Name *string

	// The cadence for Amazon Web Services to update the export in your S3 bucket.
	//
	// This member is required.
	RefreshCadence *RefreshCadence

	// The description for this specific data export.
	Description *string

	// The Amazon Resource Name (ARN) for this export.
	ExportArn *string
	// contains filtered or unexported fields
}

The details that are available for an export.

type ExportReference 

type ExportReference struct {

	// The Amazon Resource Name (ARN) for this export.
	//
	// This member is required.
	ExportArn *string

	// The name of this specific data export.
	//
	// This member is required.
	ExportName *string

	// The status of this specific data export.
	//
	// This member is required.
	ExportStatus *ExportStatus
	// contains filtered or unexported fields
}

The reference details for a given export.

type ExportStatus 

type ExportStatus struct {

	// The timestamp of when the export was created.
	CreatedAt *time.Time

	// The timestamp of when the export was last generated.
	LastRefreshedAt *time.Time

	// The timestamp of when the export was updated.
	LastUpdatedAt *time.Time

	// The status code for the request.
	StatusCode ExportStatusCode

	// The description for the status code.
	StatusReason ExecutionStatusReason
	// contains filtered or unexported fields
}

The status of the data export.

type ExportStatusCode 

type ExportStatusCode string
const (
	ExportStatusCodeHealthy   ExportStatusCode = "HEALTHY"
	ExportStatusCodeUnhealthy ExportStatusCode = "UNHEALTHY"
)

Enum values for ExportStatusCode

func (ExportStatusCode) Values 

func (ExportStatusCode) Values() []ExportStatusCode

Values returns all known values for ExportStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FormatOption 

type FormatOption string
const (
	FormatOptionTextOrCsv FormatOption = "TEXT_OR_CSV"
	FormatOptionParquet   FormatOption = "PARQUET"
)

Enum values for FormatOption

func (FormatOption) Values 

func (FormatOption) Values() []FormatOption

Values returns all known values for FormatOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FrequencyOption 

type FrequencyOption string
const (
	FrequencyOptionSynchronous FrequencyOption = "SYNCHRONOUS"
)

Enum values for FrequencyOption

func (FrequencyOption) Values 

func (FrequencyOption) Values() []FrequencyOption

Values returns all known values for FrequencyOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error on the server occurred during the processing of your request. Try again later.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type OverwriteOption 

type OverwriteOption string
const (
	OverwriteOptionCreateNewReport OverwriteOption = "CREATE_NEW_REPORT"
	OverwriteOptionOverwriteReport OverwriteOption = "OVERWRITE_REPORT"
)

Enum values for OverwriteOption

func (OverwriteOption) Values 

func (OverwriteOption) Values() []OverwriteOption

Values returns all known values for OverwriteOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RefreshCadence 

type RefreshCadence struct {

	// The frequency that data exports are updated. The export refreshes each time the
	// source data updates, up to three times daily.
	//
	// This member is required.
	Frequency FrequencyOption
	// contains filtered or unexported fields
}

The cadence for Amazon Web Services to update the data export in your S3 bucket.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The specified Amazon Resource Name (ARN) in the request doesn't exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceTag 

type ResourceTag struct {

	// The key that's associated with the tag.
	//
	// This member is required.
	Key *string

	// The value that's associated with the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The tag structure that contains a tag key and value.

type S3Destination 

type S3Destination struct {

	// The name of the Amazon S3 bucket used as the destination of a data export file.
	//
	// This member is required.
	S3Bucket *string

	// The output configuration for the data export.
	//
	// This member is required.
	S3OutputConfigurations *S3OutputConfigurations

	// The S3 path prefix you want prepended to the name of your data export.
	//
	// This member is required.
	S3Prefix *string

	// The S3 bucket Region.
	//
	// This member is required.
	S3Region *string
	// contains filtered or unexported fields
}

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a data exports file.

type S3OutputConfigurations 

type S3OutputConfigurations struct {

	// The compression type for the data export.
	//
	// This member is required.
	Compression CompressionOption

	// The file format for the data export.
	//
	// This member is required.
	Format FormatOption

	// The output type for the data export.
	//
	// This member is required.
	OutputType S3OutputType

	// The rule to follow when generating a version of the data export file. You have
	// the choice to overwrite the previous version or to be delivered in addition to
	// the previous versions. Overwriting exports can save on Amazon S3 storage costs.
	// Creating new export versions allows you to track the changes in cost and usage
	// data over time.
	//
	// This member is required.
	Overwrite OverwriteOption
	// contains filtered or unexported fields
}

The compression type, file format, and overwrite preference for the data export.

type S3OutputType 

type S3OutputType string
const (
	S3OutputTypeCustom S3OutputType = "CUSTOM"
)

Enum values for S3OutputType

func (S3OutputType) Values 

func (S3OutputType) Values() []S3OutputType

Values returns all known values for S3OutputType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	QuotaCode    *string
	ServiceCode  *string
	// contains filtered or unexported fields
}

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Table 

type Table struct {

	// The description for the table.
	Description *string

	// The name of the table.
	TableName *string

	// The properties for the table.
	TableProperties []TablePropertyDescription
	// contains filtered or unexported fields
}

The details for the data export table.

type TablePropertyDescription 

type TablePropertyDescription struct {

	// The default value for the table.
	DefaultValue *string

	// The description for the table.
	Description *string

	// The name of the table.
	Name *string

	// The valid values for the table.
	ValidValues []string
	// contains filtered or unexported fields
}

The properties for the data export table.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaCode   *string
	ServiceCode *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message with the reason for the validation exception error.
	//
	// This member is required.
	Message *string

	// The field name where the invalid entry was detected.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

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.