Documentation ¶
Overview ¶
Package timestreamwrite provides the client and types for making API requests to Amazon Timestream Write.
Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.
See https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01 for more information on this service.
See timestreamwrite package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreamwrite/
Using the Client ¶
To contact Amazon Timestream Write 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 Timestream Write client TimestreamWrite for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreamwrite/#New
Index ¶
- Constants
- func DimensionValueType_Values() []string
- func MeasureValueType_Values() []string
- func S3EncryptionOption_Values() []string
- func TableStatus_Values() []string
- func TimeUnit_Values() []string
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type CreateDatabaseInput
- func (s CreateDatabaseInput) GoString() string
- func (s *CreateDatabaseInput) SetDatabaseName(v string) *CreateDatabaseInput
- func (s *CreateDatabaseInput) SetKmsKeyId(v string) *CreateDatabaseInput
- func (s *CreateDatabaseInput) SetTags(v []*Tag) *CreateDatabaseInput
- func (s CreateDatabaseInput) String() string
- func (s *CreateDatabaseInput) Validate() error
- type CreateDatabaseOutput
- type CreateTableInput
- func (s CreateTableInput) GoString() string
- func (s *CreateTableInput) SetDatabaseName(v string) *CreateTableInput
- func (s *CreateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *CreateTableInput
- func (s *CreateTableInput) SetRetentionProperties(v *RetentionProperties) *CreateTableInput
- func (s *CreateTableInput) SetTableName(v string) *CreateTableInput
- func (s *CreateTableInput) SetTags(v []*Tag) *CreateTableInput
- func (s CreateTableInput) String() string
- func (s *CreateTableInput) Validate() error
- type CreateTableOutput
- type Database
- func (s Database) GoString() string
- func (s *Database) SetArn(v string) *Database
- func (s *Database) SetCreationTime(v time.Time) *Database
- func (s *Database) SetDatabaseName(v string) *Database
- func (s *Database) SetKmsKeyId(v string) *Database
- func (s *Database) SetLastUpdatedTime(v time.Time) *Database
- func (s *Database) SetTableCount(v int64) *Database
- func (s Database) String() string
- type DeleteDatabaseInput
- type DeleteDatabaseOutput
- type DeleteTableInput
- type DeleteTableOutput
- type DescribeDatabaseInput
- type DescribeDatabaseOutput
- type DescribeEndpointsInput
- type DescribeEndpointsOutput
- type DescribeTableInput
- type DescribeTableOutput
- type Dimension
- type Endpoint
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type InvalidEndpointException
- func (s *InvalidEndpointException) Code() string
- func (s *InvalidEndpointException) Error() string
- func (s InvalidEndpointException) GoString() string
- func (s *InvalidEndpointException) Message() string
- func (s *InvalidEndpointException) OrigErr() error
- func (s *InvalidEndpointException) RequestID() string
- func (s *InvalidEndpointException) StatusCode() int
- func (s InvalidEndpointException) String() string
- type ListDatabasesInput
- type ListDatabasesOutput
- type ListTablesInput
- func (s ListTablesInput) GoString() string
- func (s *ListTablesInput) SetDatabaseName(v string) *ListTablesInput
- func (s *ListTablesInput) SetMaxResults(v int64) *ListTablesInput
- func (s *ListTablesInput) SetNextToken(v string) *ListTablesInput
- func (s ListTablesInput) String() string
- func (s *ListTablesInput) Validate() error
- type ListTablesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type MagneticStoreRejectedDataLocation
- type MagneticStoreWriteProperties
- func (s MagneticStoreWriteProperties) GoString() string
- func (s *MagneticStoreWriteProperties) SetEnableMagneticStoreWrites(v bool) *MagneticStoreWriteProperties
- func (s *MagneticStoreWriteProperties) SetMagneticStoreRejectedDataLocation(v *MagneticStoreRejectedDataLocation) *MagneticStoreWriteProperties
- func (s MagneticStoreWriteProperties) String() string
- func (s *MagneticStoreWriteProperties) Validate() error
- type MeasureValue
- type Record
- func (s Record) GoString() string
- func (s *Record) SetDimensions(v []*Dimension) *Record
- func (s *Record) SetMeasureName(v string) *Record
- func (s *Record) SetMeasureValue(v string) *Record
- func (s *Record) SetMeasureValueType(v string) *Record
- func (s *Record) SetMeasureValues(v []*MeasureValue) *Record
- func (s *Record) SetTime(v string) *Record
- func (s *Record) SetTimeUnit(v string) *Record
- func (s *Record) SetVersion(v int64) *Record
- func (s Record) String() string
- func (s *Record) Validate() error
- type RecordsIngested
- type RejectedRecord
- type RejectedRecordsException
- func (s *RejectedRecordsException) Code() string
- func (s *RejectedRecordsException) Error() string
- func (s RejectedRecordsException) GoString() string
- func (s *RejectedRecordsException) Message() string
- func (s *RejectedRecordsException) OrigErr() error
- func (s *RejectedRecordsException) RequestID() string
- func (s *RejectedRecordsException) StatusCode() int
- func (s RejectedRecordsException) String() string
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type RetentionProperties
- func (s RetentionProperties) GoString() string
- func (s *RetentionProperties) SetMagneticStoreRetentionPeriodInDays(v int64) *RetentionProperties
- func (s *RetentionProperties) SetMemoryStoreRetentionPeriodInHours(v int64) *RetentionProperties
- func (s RetentionProperties) String() string
- func (s *RetentionProperties) Validate() error
- type S3Configuration
- func (s S3Configuration) GoString() string
- func (s *S3Configuration) SetBucketName(v string) *S3Configuration
- func (s *S3Configuration) SetEncryptionOption(v string) *S3Configuration
- func (s *S3Configuration) SetKmsKeyId(v string) *S3Configuration
- func (s *S3Configuration) SetObjectKeyPrefix(v string) *S3Configuration
- func (s S3Configuration) String() string
- func (s *S3Configuration) Validate() error
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type Table
- func (s Table) GoString() string
- func (s *Table) SetArn(v string) *Table
- func (s *Table) SetCreationTime(v time.Time) *Table
- func (s *Table) SetDatabaseName(v string) *Table
- func (s *Table) SetLastUpdatedTime(v time.Time) *Table
- func (s *Table) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *Table
- func (s *Table) SetRetentionProperties(v *RetentionProperties) *Table
- func (s *Table) SetTableName(v string) *Table
- func (s *Table) SetTableStatus(v string) *Table
- func (s Table) String() string
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type ThrottlingException
- func (s *ThrottlingException) Code() string
- func (s *ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s *ThrottlingException) Message() string
- func (s *ThrottlingException) OrigErr() error
- func (s *ThrottlingException) RequestID() string
- func (s *ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type TimestreamWrite
- func (c *TimestreamWrite) CreateDatabase(input *CreateDatabaseInput) (*CreateDatabaseOutput, error)
- func (c *TimestreamWrite) CreateDatabaseRequest(input *CreateDatabaseInput) (req *request.Request, output *CreateDatabaseOutput)
- func (c *TimestreamWrite) CreateDatabaseWithContext(ctx aws.Context, input *CreateDatabaseInput, opts ...request.Option) (*CreateDatabaseOutput, error)
- func (c *TimestreamWrite) CreateTable(input *CreateTableInput) (*CreateTableOutput, error)
- func (c *TimestreamWrite) CreateTableRequest(input *CreateTableInput) (req *request.Request, output *CreateTableOutput)
- func (c *TimestreamWrite) CreateTableWithContext(ctx aws.Context, input *CreateTableInput, opts ...request.Option) (*CreateTableOutput, error)
- func (c *TimestreamWrite) DeleteDatabase(input *DeleteDatabaseInput) (*DeleteDatabaseOutput, error)
- func (c *TimestreamWrite) DeleteDatabaseRequest(input *DeleteDatabaseInput) (req *request.Request, output *DeleteDatabaseOutput)
- func (c *TimestreamWrite) DeleteDatabaseWithContext(ctx aws.Context, input *DeleteDatabaseInput, opts ...request.Option) (*DeleteDatabaseOutput, error)
- func (c *TimestreamWrite) DeleteTable(input *DeleteTableInput) (*DeleteTableOutput, error)
- func (c *TimestreamWrite) DeleteTableRequest(input *DeleteTableInput) (req *request.Request, output *DeleteTableOutput)
- func (c *TimestreamWrite) DeleteTableWithContext(ctx aws.Context, input *DeleteTableInput, opts ...request.Option) (*DeleteTableOutput, error)
- func (c *TimestreamWrite) DescribeDatabase(input *DescribeDatabaseInput) (*DescribeDatabaseOutput, error)
- func (c *TimestreamWrite) DescribeDatabaseRequest(input *DescribeDatabaseInput) (req *request.Request, output *DescribeDatabaseOutput)
- func (c *TimestreamWrite) DescribeDatabaseWithContext(ctx aws.Context, input *DescribeDatabaseInput, opts ...request.Option) (*DescribeDatabaseOutput, error)
- func (c *TimestreamWrite) DescribeEndpoints(input *DescribeEndpointsInput) (*DescribeEndpointsOutput, error)
- func (c *TimestreamWrite) DescribeEndpointsRequest(input *DescribeEndpointsInput) (req *request.Request, output *DescribeEndpointsOutput)
- func (c *TimestreamWrite) DescribeEndpointsWithContext(ctx aws.Context, input *DescribeEndpointsInput, opts ...request.Option) (*DescribeEndpointsOutput, error)
- func (c *TimestreamWrite) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error)
- func (c *TimestreamWrite) DescribeTableRequest(input *DescribeTableInput) (req *request.Request, output *DescribeTableOutput)
- func (c *TimestreamWrite) DescribeTableWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.Option) (*DescribeTableOutput, error)
- func (c *TimestreamWrite) ListDatabases(input *ListDatabasesInput) (*ListDatabasesOutput, error)
- func (c *TimestreamWrite) ListDatabasesPages(input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool) error
- func (c *TimestreamWrite) ListDatabasesPagesWithContext(ctx aws.Context, input *ListDatabasesInput, ...) error
- func (c *TimestreamWrite) ListDatabasesRequest(input *ListDatabasesInput) (req *request.Request, output *ListDatabasesOutput)
- func (c *TimestreamWrite) ListDatabasesWithContext(ctx aws.Context, input *ListDatabasesInput, opts ...request.Option) (*ListDatabasesOutput, error)
- func (c *TimestreamWrite) ListTables(input *ListTablesInput) (*ListTablesOutput, error)
- func (c *TimestreamWrite) ListTablesPages(input *ListTablesInput, fn func(*ListTablesOutput, bool) bool) error
- func (c *TimestreamWrite) ListTablesPagesWithContext(ctx aws.Context, input *ListTablesInput, fn func(*ListTablesOutput, bool) bool, ...) error
- func (c *TimestreamWrite) ListTablesRequest(input *ListTablesInput) (req *request.Request, output *ListTablesOutput)
- func (c *TimestreamWrite) ListTablesWithContext(ctx aws.Context, input *ListTablesInput, opts ...request.Option) (*ListTablesOutput, error)
- func (c *TimestreamWrite) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *TimestreamWrite) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *TimestreamWrite) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *TimestreamWrite) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *TimestreamWrite) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *TimestreamWrite) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *TimestreamWrite) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *TimestreamWrite) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *TimestreamWrite) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- func (c *TimestreamWrite) UpdateDatabase(input *UpdateDatabaseInput) (*UpdateDatabaseOutput, error)
- func (c *TimestreamWrite) UpdateDatabaseRequest(input *UpdateDatabaseInput) (req *request.Request, output *UpdateDatabaseOutput)
- func (c *TimestreamWrite) UpdateDatabaseWithContext(ctx aws.Context, input *UpdateDatabaseInput, opts ...request.Option) (*UpdateDatabaseOutput, error)
- func (c *TimestreamWrite) UpdateTable(input *UpdateTableInput) (*UpdateTableOutput, error)
- func (c *TimestreamWrite) UpdateTableRequest(input *UpdateTableInput) (req *request.Request, output *UpdateTableOutput)
- func (c *TimestreamWrite) UpdateTableWithContext(ctx aws.Context, input *UpdateTableInput, opts ...request.Option) (*UpdateTableOutput, error)
- func (c *TimestreamWrite) WriteRecords(input *WriteRecordsInput) (*WriteRecordsOutput, error)
- func (c *TimestreamWrite) WriteRecordsRequest(input *WriteRecordsInput) (req *request.Request, output *WriteRecordsOutput)
- func (c *TimestreamWrite) WriteRecordsWithContext(ctx aws.Context, input *WriteRecordsInput, opts ...request.Option) (*WriteRecordsOutput, error)
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateDatabaseInput
- type UpdateDatabaseOutput
- type UpdateTableInput
- func (s UpdateTableInput) GoString() string
- func (s *UpdateTableInput) SetDatabaseName(v string) *UpdateTableInput
- func (s *UpdateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *UpdateTableInput
- func (s *UpdateTableInput) SetRetentionProperties(v *RetentionProperties) *UpdateTableInput
- func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput
- func (s UpdateTableInput) String() string
- func (s *UpdateTableInput) Validate() error
- type UpdateTableOutput
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
- type WriteRecordsInput
- func (s WriteRecordsInput) GoString() string
- func (s *WriteRecordsInput) SetCommonAttributes(v *Record) *WriteRecordsInput
- func (s *WriteRecordsInput) SetDatabaseName(v string) *WriteRecordsInput
- func (s *WriteRecordsInput) SetRecords(v []*Record) *WriteRecordsInput
- func (s *WriteRecordsInput) SetTableName(v string) *WriteRecordsInput
- func (s WriteRecordsInput) String() string
- func (s *WriteRecordsInput) Validate() error
- type WriteRecordsOutput
Constants ¶
const ( // MeasureValueTypeDouble is a MeasureValueType enum value MeasureValueTypeDouble = "DOUBLE" // MeasureValueTypeBigint is a MeasureValueType enum value MeasureValueTypeBigint = "BIGINT" // MeasureValueTypeVarchar is a MeasureValueType enum value MeasureValueTypeVarchar = "VARCHAR" // MeasureValueTypeBoolean is a MeasureValueType enum value MeasureValueTypeBoolean = "BOOLEAN" // MeasureValueTypeTimestamp is a MeasureValueType enum value MeasureValueTypeTimestamp = "TIMESTAMP" // MeasureValueTypeMulti is a MeasureValueType enum value MeasureValueTypeMulti = "MULTI" )
const ( // S3EncryptionOptionSseS3 is a S3EncryptionOption enum value S3EncryptionOptionSseS3 = "SSE_S3" // S3EncryptionOptionSseKms is a S3EncryptionOption enum value S3EncryptionOptionSseKms = "SSE_KMS" )
const ( // TableStatusActive is a TableStatus enum value TableStatusActive = "ACTIVE" // TableStatusDeleting is a TableStatus enum value TableStatusDeleting = "DELETING" )
const ( // TimeUnitMilliseconds is a TimeUnit enum value TimeUnitMilliseconds = "MILLISECONDS" // TimeUnitSeconds is a TimeUnit enum value TimeUnitSeconds = "SECONDS" // TimeUnitMicroseconds is a TimeUnit enum value TimeUnitMicroseconds = "MICROSECONDS" // TimeUnitNanoseconds is a TimeUnit enum value TimeUnitNanoseconds = "NANOSECONDS" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You are not authorized to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // // Timestream was unable to process this request because it contains resource // that already exists. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // Timestream was unable to fully process this request because of an internal // server error. ErrCodeInternalServerException = "InternalServerException" // ErrCodeInvalidEndpointException for service response error code // "InvalidEndpointException". // // The requested endpoint was invalid. ErrCodeInvalidEndpointException = "InvalidEndpointException" // ErrCodeRejectedRecordsException for service response error code // "RejectedRecordsException". // // WriteRecords would throw this exception in the following cases: // // * Records with duplicate data where there are multiple records with the // same dimensions, timestamps, and measure names but: Measure values are // different Version is not present in the request or the value of version // in the new record is equal to or lower than the existing value In this // case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords // response will indicate the current record’s version. To force an update, // you can resend the request with a version for the record set to a value // greater than the ExistingVersion. // // * Records with timestamps that lie outside the retention duration of the // memory store // // * Records with dimensions or measures that exceed the Timestream defined // limits. // // For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) // in the Timestream Developer Guide. ErrCodeRejectedRecordsException = "RejectedRecordsException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The operation tried to access a nonexistent resource. The resource might // not be specified correctly, or its status might not be ACTIVE. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // Instance quota of resource exceeded for this account. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // Too many requests were made by a user exceeding service quotas. The request // was throttled. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // Invalid or malformed request. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "Timestream Write" // Name of service. EndpointsID = "ingest.timestream" // ID to lookup a service endpoint with. ServiceID = "Timestream Write" // ServiceID is a unique identifier of a specific service. )
Service information constants
const (
// DimensionValueTypeVarchar is a DimensionValueType enum value
DimensionValueTypeVarchar = "VARCHAR"
)
Variables ¶
This section is empty.
Functions ¶
func DimensionValueType_Values ¶
func DimensionValueType_Values() []string
DimensionValueType_Values returns all elements of the DimensionValueType enum
func MeasureValueType_Values ¶
func MeasureValueType_Values() []string
MeasureValueType_Values returns all elements of the MeasureValueType enum
func S3EncryptionOption_Values ¶ added in v1.42.12
func S3EncryptionOption_Values() []string
S3EncryptionOption_Values returns all elements of the S3EncryptionOption enum
func TableStatus_Values ¶
func TableStatus_Values() []string
TableStatus_Values returns all elements of the TableStatus enum
func TimeUnit_Values ¶
func TimeUnit_Values() []string
TimeUnit_Values returns all elements of the TimeUnit enum
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
You are not authorized to perform this action.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException ¶
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
Timestream was unable to process this request because it contains resource that already exists.
func (*ConflictException) Code ¶
func (s *ConflictException) Code() string
Code returns the exception type name.
func (*ConflictException) Error ¶
func (s *ConflictException) Error() string
func (ConflictException) GoString ¶
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ConflictException) Message ¶
func (s *ConflictException) Message() string
Message returns the exception's message.
func (*ConflictException) OrigErr ¶
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ConflictException) RequestID ¶
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ConflictException) StatusCode ¶
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateDatabaseInput ¶
type CreateDatabaseInput struct { // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // The KMS key for the database. If the KMS key is not specified, the database // will be encrypted with a Timestream managed KMS key located in your account. // Refer to Amazon Web Services managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) // for more info. KmsKeyId *string `min:"1" type:"string"` // A list of key-value pairs to label the table. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (CreateDatabaseInput) GoString ¶
func (s CreateDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateDatabaseInput) SetDatabaseName ¶
func (s *CreateDatabaseInput) SetDatabaseName(v string) *CreateDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (*CreateDatabaseInput) SetKmsKeyId ¶
func (s *CreateDatabaseInput) SetKmsKeyId(v string) *CreateDatabaseInput
SetKmsKeyId sets the KmsKeyId field's value.
func (*CreateDatabaseInput) SetTags ¶
func (s *CreateDatabaseInput) SetTags(v []*Tag) *CreateDatabaseInput
SetTags sets the Tags field's value.
func (CreateDatabaseInput) String ¶
func (s CreateDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateDatabaseInput) Validate ¶
func (s *CreateDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDatabaseOutput ¶
type CreateDatabaseOutput struct { // The newly created Timestream database. Database *Database `type:"structure"` // contains filtered or unexported fields }
func (CreateDatabaseOutput) GoString ¶
func (s CreateDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateDatabaseOutput) SetDatabase ¶
func (s *CreateDatabaseOutput) SetDatabase(v *Database) *CreateDatabaseOutput
SetDatabase sets the Database field's value.
func (CreateDatabaseOutput) String ¶
func (s CreateDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateTableInput ¶
type CreateTableInput struct { // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // Contains properties to set on the table when enabling magnetic store writes. MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"` // The duration for which your time series data must be stored in the memory // store and the magnetic store. RetentionProperties *RetentionProperties `type:"structure"` // The name of the Timestream table. // // TableName is a required field TableName *string `type:"string" required:"true"` // A list of key-value pairs to label the table. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (CreateTableInput) GoString ¶
func (s CreateTableInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateTableInput) SetDatabaseName ¶
func (s *CreateTableInput) SetDatabaseName(v string) *CreateTableInput
SetDatabaseName sets the DatabaseName field's value.
func (*CreateTableInput) SetMagneticStoreWriteProperties ¶ added in v1.42.12
func (s *CreateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *CreateTableInput
SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.
func (*CreateTableInput) SetRetentionProperties ¶
func (s *CreateTableInput) SetRetentionProperties(v *RetentionProperties) *CreateTableInput
SetRetentionProperties sets the RetentionProperties field's value.
func (*CreateTableInput) SetTableName ¶
func (s *CreateTableInput) SetTableName(v string) *CreateTableInput
SetTableName sets the TableName field's value.
func (*CreateTableInput) SetTags ¶
func (s *CreateTableInput) SetTags(v []*Tag) *CreateTableInput
SetTags sets the Tags field's value.
func (CreateTableInput) String ¶
func (s CreateTableInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateTableInput) Validate ¶
func (s *CreateTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTableOutput ¶
type CreateTableOutput struct { // The newly created Timestream table. Table *Table `type:"structure"` // contains filtered or unexported fields }
func (CreateTableOutput) GoString ¶
func (s CreateTableOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateTableOutput) SetTable ¶
func (s *CreateTableOutput) SetTable(v *Table) *CreateTableOutput
SetTable sets the Table field's value.
func (CreateTableOutput) String ¶
func (s CreateTableOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Database ¶
type Database struct { // The Amazon Resource Name that uniquely identifies this database. Arn *string `type:"string"` // The time when the database was created, calculated from the Unix epoch time. CreationTime *time.Time `type:"timestamp"` // The name of the Timestream database. DatabaseName *string `type:"string"` // The identifier of the KMS key used to encrypt the data stored in the database. KmsKeyId *string `min:"1" type:"string"` // The last time that this database was updated. LastUpdatedTime *time.Time `type:"timestamp"` // The total number of tables found within a Timestream database. TableCount *int64 `type:"long"` // contains filtered or unexported fields }
A top level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.
func (Database) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Database) SetCreationTime ¶
SetCreationTime sets the CreationTime field's value.
func (*Database) SetDatabaseName ¶
SetDatabaseName sets the DatabaseName field's value.
func (*Database) SetKmsKeyId ¶
SetKmsKeyId sets the KmsKeyId field's value.
func (*Database) SetLastUpdatedTime ¶
SetLastUpdatedTime sets the LastUpdatedTime field's value.
func (*Database) SetTableCount ¶
SetTableCount sets the TableCount field's value.
type DeleteDatabaseInput ¶
type DeleteDatabaseInput struct { // The name of the Timestream database to be deleted. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteDatabaseInput) GoString ¶
func (s DeleteDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteDatabaseInput) SetDatabaseName ¶
func (s *DeleteDatabaseInput) SetDatabaseName(v string) *DeleteDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (DeleteDatabaseInput) String ¶
func (s DeleteDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteDatabaseInput) Validate ¶
func (s *DeleteDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDatabaseOutput ¶
type DeleteDatabaseOutput struct {
// contains filtered or unexported fields
}
func (DeleteDatabaseOutput) GoString ¶
func (s DeleteDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteDatabaseOutput) String ¶
func (s DeleteDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteTableInput ¶
type DeleteTableInput struct { // The name of the database where the Timestream database is to be deleted. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // The name of the Timestream table to be deleted. // // TableName is a required field TableName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteTableInput) GoString ¶
func (s DeleteTableInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteTableInput) SetDatabaseName ¶
func (s *DeleteTableInput) SetDatabaseName(v string) *DeleteTableInput
SetDatabaseName sets the DatabaseName field's value.
func (*DeleteTableInput) SetTableName ¶
func (s *DeleteTableInput) SetTableName(v string) *DeleteTableInput
SetTableName sets the TableName field's value.
func (DeleteTableInput) String ¶
func (s DeleteTableInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteTableInput) Validate ¶
func (s *DeleteTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTableOutput ¶
type DeleteTableOutput struct {
// contains filtered or unexported fields
}
func (DeleteTableOutput) GoString ¶
func (s DeleteTableOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteTableOutput) String ¶
func (s DeleteTableOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDatabaseInput ¶
type DescribeDatabaseInput struct { // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeDatabaseInput) GoString ¶
func (s DescribeDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeDatabaseInput) SetDatabaseName ¶
func (s *DescribeDatabaseInput) SetDatabaseName(v string) *DescribeDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (DescribeDatabaseInput) String ¶
func (s DescribeDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeDatabaseInput) Validate ¶
func (s *DescribeDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDatabaseOutput ¶
type DescribeDatabaseOutput struct { // The name of the Timestream table. Database *Database `type:"structure"` // contains filtered or unexported fields }
func (DescribeDatabaseOutput) GoString ¶
func (s DescribeDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeDatabaseOutput) SetDatabase ¶
func (s *DescribeDatabaseOutput) SetDatabase(v *Database) *DescribeDatabaseOutput
SetDatabase sets the Database field's value.
func (DescribeDatabaseOutput) String ¶
func (s DescribeDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEndpointsInput ¶
type DescribeEndpointsInput struct {
// contains filtered or unexported fields
}
func (DescribeEndpointsInput) GoString ¶
func (s DescribeEndpointsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DescribeEndpointsInput) String ¶
func (s DescribeEndpointsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEndpointsOutput ¶
type DescribeEndpointsOutput struct { // An Endpoints object is returned when a DescribeEndpoints request is made. // // Endpoints is a required field Endpoints []*Endpoint `type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeEndpointsOutput) GoString ¶
func (s DescribeEndpointsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeEndpointsOutput) SetEndpoints ¶
func (s *DescribeEndpointsOutput) SetEndpoints(v []*Endpoint) *DescribeEndpointsOutput
SetEndpoints sets the Endpoints field's value.
func (DescribeEndpointsOutput) String ¶
func (s DescribeEndpointsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeTableInput ¶
type DescribeTableInput struct { // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // The name of the Timestream table. // // TableName is a required field TableName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeTableInput) GoString ¶
func (s DescribeTableInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeTableInput) SetDatabaseName ¶
func (s *DescribeTableInput) SetDatabaseName(v string) *DescribeTableInput
SetDatabaseName sets the DatabaseName field's value.
func (*DescribeTableInput) SetTableName ¶
func (s *DescribeTableInput) SetTableName(v string) *DescribeTableInput
SetTableName sets the TableName field's value.
func (DescribeTableInput) String ¶
func (s DescribeTableInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeTableInput) Validate ¶
func (s *DescribeTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTableOutput ¶
type DescribeTableOutput struct { // The Timestream table. Table *Table `type:"structure"` // contains filtered or unexported fields }
func (DescribeTableOutput) GoString ¶
func (s DescribeTableOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DescribeTableOutput) SetTable ¶
func (s *DescribeTableOutput) SetTable(v *Table) *DescribeTableOutput
SetTable sets the Table field's value.
func (DescribeTableOutput) String ¶
func (s DescribeTableOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Dimension ¶
type Dimension struct { // The data type of the dimension for the time series data point. DimensionValueType *string `type:"string" enum:"DimensionValueType"` // Dimension represents the meta data attributes of the time series. For example, // the name and availability zone of an EC2 instance or the name of the manufacturer // of a wind turbine are dimensions. // // For constraints on Dimension names, see Naming Constraints (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming). // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The value of the dimension. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions.
func (Dimension) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Dimension) SetDimensionValueType ¶
SetDimensionValueType sets the DimensionValueType field's value.
type Endpoint ¶
type Endpoint struct { // An endpoint address. // // Address is a required field Address *string `type:"string" required:"true"` // The TTL for the endpoint, in minutes. // // CachePeriodInMinutes is a required field CachePeriodInMinutes *int64 `type:"long" required:"true"` // contains filtered or unexported fields }
Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.
func (Endpoint) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Endpoint) SetAddress ¶
SetAddress sets the Address field's value.
func (*Endpoint) SetCachePeriodInMinutes ¶
SetCachePeriodInMinutes sets the CachePeriodInMinutes field's value.
type InternalServerException ¶
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
Timestream was unable to fully process this request because of an internal server error.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidEndpointException ¶
type InvalidEndpointException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The requested endpoint was invalid.
func (*InvalidEndpointException) Code ¶
func (s *InvalidEndpointException) Code() string
Code returns the exception type name.
func (*InvalidEndpointException) Error ¶
func (s *InvalidEndpointException) Error() string
func (InvalidEndpointException) GoString ¶
func (s InvalidEndpointException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InvalidEndpointException) Message ¶
func (s *InvalidEndpointException) Message() string
Message returns the exception's message.
func (*InvalidEndpointException) OrigErr ¶
func (s *InvalidEndpointException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InvalidEndpointException) RequestID ¶
func (s *InvalidEndpointException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InvalidEndpointException) StatusCode ¶
func (s *InvalidEndpointException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InvalidEndpointException) String ¶
func (s InvalidEndpointException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDatabasesInput ¶
type ListDatabasesInput struct { // The total number of items to return in the output. If the total number of // items available is more than the value specified, a NextToken is provided // in the output. To resume pagination, provide the NextToken value as argument // of a subsequent API invocation. MaxResults *int64 `min:"1" type:"integer"` // The pagination token. To resume pagination, provide the NextToken value as // argument of a subsequent API invocation. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListDatabasesInput) GoString ¶
func (s ListDatabasesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDatabasesInput) SetMaxResults ¶
func (s *ListDatabasesInput) SetMaxResults(v int64) *ListDatabasesInput
SetMaxResults sets the MaxResults field's value.
func (*ListDatabasesInput) SetNextToken ¶
func (s *ListDatabasesInput) SetNextToken(v string) *ListDatabasesInput
SetNextToken sets the NextToken field's value.
func (ListDatabasesInput) String ¶
func (s ListDatabasesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDatabasesInput) Validate ¶
func (s *ListDatabasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDatabasesOutput ¶
type ListDatabasesOutput struct { // A list of database names. Databases []*Database `type:"list"` // The pagination token. This parameter is returned when the response is truncated. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListDatabasesOutput) GoString ¶
func (s ListDatabasesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDatabasesOutput) SetDatabases ¶
func (s *ListDatabasesOutput) SetDatabases(v []*Database) *ListDatabasesOutput
SetDatabases sets the Databases field's value.
func (*ListDatabasesOutput) SetNextToken ¶
func (s *ListDatabasesOutput) SetNextToken(v string) *ListDatabasesOutput
SetNextToken sets the NextToken field's value.
func (ListDatabasesOutput) String ¶
func (s ListDatabasesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTablesInput ¶
type ListTablesInput struct { // The name of the Timestream database. DatabaseName *string `type:"string"` // The total number of items to return in the output. If the total number of // items available is more than the value specified, a NextToken is provided // in the output. To resume pagination, provide the NextToken value as argument // of a subsequent API invocation. MaxResults *int64 `min:"1" type:"integer"` // The pagination token. To resume pagination, provide the NextToken value as // argument of a subsequent API invocation. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListTablesInput) GoString ¶
func (s ListTablesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTablesInput) SetDatabaseName ¶
func (s *ListTablesInput) SetDatabaseName(v string) *ListTablesInput
SetDatabaseName sets the DatabaseName field's value.
func (*ListTablesInput) SetMaxResults ¶
func (s *ListTablesInput) SetMaxResults(v int64) *ListTablesInput
SetMaxResults sets the MaxResults field's value.
func (*ListTablesInput) SetNextToken ¶
func (s *ListTablesInput) SetNextToken(v string) *ListTablesInput
SetNextToken sets the NextToken field's value.
func (ListTablesInput) String ¶
func (s ListTablesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTablesInput) Validate ¶
func (s *ListTablesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTablesOutput ¶
type ListTablesOutput struct { // A token to specify where to start paginating. This is the NextToken from // a previously truncated response. NextToken *string `type:"string"` // A list of tables. Tables []*Table `type:"list"` // contains filtered or unexported fields }
func (ListTablesOutput) GoString ¶
func (s ListTablesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTablesOutput) SetNextToken ¶
func (s *ListTablesOutput) SetNextToken(v string) *ListTablesOutput
SetNextToken sets the NextToken field's value.
func (*ListTablesOutput) SetTables ¶
func (s *ListTablesOutput) SetTables(v []*Table) *ListTablesOutput
SetTables sets the Tables field's value.
func (ListTablesOutput) String ¶
func (s ListTablesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Timestream resource with tags to be listed. This value is an Amazon Resource // Name (ARN). // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) SetResourceARN ¶
func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput
SetResourceARN sets the ResourceARN field's value.
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags currently associated with the Timestream resource. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceOutput) SetTags ¶
func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MagneticStoreRejectedDataLocation ¶ added in v1.42.12
type MagneticStoreRejectedDataLocation struct { // Configuration of an S3 location to write error reports for records rejected, // asynchronously, during magnetic store writes. S3Configuration *S3Configuration `type:"structure"` // contains filtered or unexported fields }
The location to write error reports for records rejected, asynchronously, during magnetic store writes.
func (MagneticStoreRejectedDataLocation) GoString ¶ added in v1.42.12
func (s MagneticStoreRejectedDataLocation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MagneticStoreRejectedDataLocation) SetS3Configuration ¶ added in v1.42.12
func (s *MagneticStoreRejectedDataLocation) SetS3Configuration(v *S3Configuration) *MagneticStoreRejectedDataLocation
SetS3Configuration sets the S3Configuration field's value.
func (MagneticStoreRejectedDataLocation) String ¶ added in v1.42.12
func (s MagneticStoreRejectedDataLocation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MagneticStoreRejectedDataLocation) Validate ¶ added in v1.42.12
func (s *MagneticStoreRejectedDataLocation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MagneticStoreWriteProperties ¶ added in v1.42.12
type MagneticStoreWriteProperties struct { // A flag to enable magnetic store writes. // // EnableMagneticStoreWrites is a required field EnableMagneticStoreWrites *bool `type:"boolean" required:"true"` // The location to write error reports for records rejected asynchronously during // magnetic store writes. MagneticStoreRejectedDataLocation *MagneticStoreRejectedDataLocation `type:"structure"` // contains filtered or unexported fields }
The set of properties on a table for configuring magnetic store writes.
func (MagneticStoreWriteProperties) GoString ¶ added in v1.42.12
func (s MagneticStoreWriteProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MagneticStoreWriteProperties) SetEnableMagneticStoreWrites ¶ added in v1.42.12
func (s *MagneticStoreWriteProperties) SetEnableMagneticStoreWrites(v bool) *MagneticStoreWriteProperties
SetEnableMagneticStoreWrites sets the EnableMagneticStoreWrites field's value.
func (*MagneticStoreWriteProperties) SetMagneticStoreRejectedDataLocation ¶ added in v1.42.12
func (s *MagneticStoreWriteProperties) SetMagneticStoreRejectedDataLocation(v *MagneticStoreRejectedDataLocation) *MagneticStoreWriteProperties
SetMagneticStoreRejectedDataLocation sets the MagneticStoreRejectedDataLocation field's value.
func (MagneticStoreWriteProperties) String ¶ added in v1.42.12
func (s MagneticStoreWriteProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MagneticStoreWriteProperties) Validate ¶ added in v1.42.12
func (s *MagneticStoreWriteProperties) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MeasureValue ¶ added in v1.42.12
type MeasureValue struct { // Name of the MeasureValue. // // For constraints on MeasureValue names, refer to Naming Constraints (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming) // in the Timestream developer guide. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // Contains the data type of the MeasureValue for the time series data point. // // Type is a required field Type *string `type:"string" required:"true" enum:"MeasureValueType"` // Value for the MeasureValue. // // Value is a required field Value *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
MeasureValue represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureValue has both name and value.
MeasureValue is only allowed for type MULTI. Using MULTI type, you can pass multiple data attributes associated with the same time series in a single record
func (MeasureValue) GoString ¶ added in v1.42.12
func (s MeasureValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MeasureValue) SetName ¶ added in v1.42.12
func (s *MeasureValue) SetName(v string) *MeasureValue
SetName sets the Name field's value.
func (*MeasureValue) SetType ¶ added in v1.42.12
func (s *MeasureValue) SetType(v string) *MeasureValue
SetType sets the Type field's value.
func (*MeasureValue) SetValue ¶ added in v1.42.12
func (s *MeasureValue) SetValue(v string) *MeasureValue
SetValue sets the Value field's value.
func (MeasureValue) String ¶ added in v1.42.12
func (s MeasureValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MeasureValue) Validate ¶ added in v1.42.12
func (s *MeasureValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Record ¶
type Record struct { // Contains the list of dimensions for time series data points. Dimensions []*Dimension `type:"list"` // Measure represents the data attribute of the time series. For example, the // CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureName *string `min:"1" type:"string"` // Contains the measure value for the time series data point. MeasureValue *string `min:"1" type:"string"` // Contains the data type of the measure value for the time series data point. // Default type is DOUBLE. MeasureValueType *string `type:"string" enum:"MeasureValueType"` // Contains the list of MeasureValue for time series data points. // // This is only allowed for type MULTI. For scalar values, use MeasureValue // attribute of the Record directly. MeasureValues []*MeasureValue `type:"list"` // Contains the time at which the measure value for the data point was collected. // The time value plus the unit provides the time elapsed since the epoch. For // example, if the time value is 12345 and the unit is ms, then 12345 ms have // elapsed since the epoch. Time *string `min:"1" type:"string"` // The granularity of the timestamp unit. It indicates if the time value is // in seconds, milliseconds, nanoseconds or other supported values. Default // is MILLISECONDS. TimeUnit *string `type:"string" enum:"TimeUnit"` // 64-bit attribute used for record updates. Write requests for duplicate data // with a higher version number will update the existing measure value and version. // In cases where the measure value is the same, Version will still be updated // . Default value is 1. // // Version must be 1 or greater, or you will receive a ValidationException error. Version *int64 `type:"long"` // contains filtered or unexported fields }
Record represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data attributes of a time series data point such as the instance name or availability zone of an EC2 instance. A record also contains the measure name which is the name of the measure being collected for example the CPU utilization of an EC2 instance. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp.
Records have a Version field, which is a 64-bit long that you can use for updating data points. Writes of a duplicate record with the same dimension, timestamp, and measure name but different measure value will only succeed if the Version attribute of the record in the write request is higher than that of the existing record. Timestream defaults to a Version of 1 for records without the Version field.
func (Record) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Record) SetDimensions ¶
SetDimensions sets the Dimensions field's value.
func (*Record) SetMeasureName ¶
SetMeasureName sets the MeasureName field's value.
func (*Record) SetMeasureValue ¶
SetMeasureValue sets the MeasureValue field's value.
func (*Record) SetMeasureValueType ¶
SetMeasureValueType sets the MeasureValueType field's value.
func (*Record) SetMeasureValues ¶ added in v1.42.12
func (s *Record) SetMeasureValues(v []*MeasureValue) *Record
SetMeasureValues sets the MeasureValues field's value.
func (*Record) SetTimeUnit ¶
SetTimeUnit sets the TimeUnit field's value.
func (*Record) SetVersion ¶ added in v1.35.35
SetVersion sets the Version field's value.
type RecordsIngested ¶ added in v1.42.12
type RecordsIngested struct { // Count of records ingested into the magnetic store. MagneticStore *int64 `type:"integer"` // Count of records ingested into the memory store. MemoryStore *int64 `type:"integer"` // Total count of successfully ingested records. Total *int64 `type:"integer"` // contains filtered or unexported fields }
Information on the records ingested by this request.
func (RecordsIngested) GoString ¶ added in v1.42.12
func (s RecordsIngested) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RecordsIngested) SetMagneticStore ¶ added in v1.42.12
func (s *RecordsIngested) SetMagneticStore(v int64) *RecordsIngested
SetMagneticStore sets the MagneticStore field's value.
func (*RecordsIngested) SetMemoryStore ¶ added in v1.42.12
func (s *RecordsIngested) SetMemoryStore(v int64) *RecordsIngested
SetMemoryStore sets the MemoryStore field's value.
func (*RecordsIngested) SetTotal ¶ added in v1.42.12
func (s *RecordsIngested) SetTotal(v int64) *RecordsIngested
SetTotal sets the Total field's value.
func (RecordsIngested) String ¶ added in v1.42.12
func (s RecordsIngested) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RejectedRecord ¶
type RejectedRecord struct { // The existing version of the record. This value is populated in scenarios // where an identical record exists with a higher version than the version in // the write request. ExistingVersion *int64 `type:"long"` // The reason why a record was not successfully inserted into Timestream. Possible // causes of failure include: // // * Records with duplicate data where there are multiple records with the // same dimensions, timestamps, and measure names but: Measure values are // different Version is not present in the request or the value of version // in the new record is equal to or lower than the existing value If Timestream // rejects data for this case, the ExistingVersion field in the RejectedRecords // response will indicate the current record’s version. To force an update, // you can resend the request with a version for the record set to a value // greater than the ExistingVersion. // // * Records with timestamps that lie outside the retention duration of the // memory store When the retention window is updated, you will receive a // RejectedRecords exception if you immediately try to ingest data within // the new window. To avoid a RejectedRecords exception, wait until the duration // of the new window to ingest new data. For further information, see Best // Practices for Configuring Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration) // and the explanation of how storage works in Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html). // // * Records with dimensions or measures that exceed the Timestream defined // limits. // // For more information, see Access Management (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) // in the Timestream Developer Guide. Reason *string `type:"string"` // The index of the record in the input request for WriteRecords. Indexes begin // with 0. RecordIndex *int64 `type:"integer"` // contains filtered or unexported fields }
Records that were not successfully inserted into Timestream due to data validation issues that must be resolved prior to reinserting time series data into the system.
func (RejectedRecord) GoString ¶
func (s RejectedRecord) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RejectedRecord) SetExistingVersion ¶ added in v1.35.35
func (s *RejectedRecord) SetExistingVersion(v int64) *RejectedRecord
SetExistingVersion sets the ExistingVersion field's value.
func (*RejectedRecord) SetReason ¶
func (s *RejectedRecord) SetReason(v string) *RejectedRecord
SetReason sets the Reason field's value.
func (*RejectedRecord) SetRecordIndex ¶
func (s *RejectedRecord) SetRecordIndex(v int64) *RejectedRecord
SetRecordIndex sets the RecordIndex field's value.
func (RejectedRecord) String ¶
func (s RejectedRecord) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RejectedRecordsException ¶
type RejectedRecordsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` RejectedRecords []*RejectedRecord `type:"list"` // contains filtered or unexported fields }
WriteRecords would throw this exception in the following cases:
Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but: Measure values are different Version is not present in the request or the value of version in the new record is equal to or lower than the existing value In this case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords response will indicate the current record’s version. To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.
Records with timestamps that lie outside the retention duration of the memory store
Records with dimensions or measures that exceed the Timestream defined limits.
For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Timestream Developer Guide.
func (*RejectedRecordsException) Code ¶
func (s *RejectedRecordsException) Code() string
Code returns the exception type name.
func (*RejectedRecordsException) Error ¶
func (s *RejectedRecordsException) Error() string
func (RejectedRecordsException) GoString ¶
func (s RejectedRecordsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RejectedRecordsException) Message ¶
func (s *RejectedRecordsException) Message() string
Message returns the exception's message.
func (*RejectedRecordsException) OrigErr ¶
func (s *RejectedRecordsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*RejectedRecordsException) RequestID ¶
func (s *RejectedRecordsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*RejectedRecordsException) StatusCode ¶
func (s *RejectedRecordsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (RejectedRecordsException) String ¶
func (s RejectedRecordsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RetentionProperties ¶
type RetentionProperties struct { // The duration for which data must be stored in the magnetic store. // // MagneticStoreRetentionPeriodInDays is a required field MagneticStoreRetentionPeriodInDays *int64 `min:"1" type:"long" required:"true"` // The duration for which data must be stored in the memory store. // // MemoryStoreRetentionPeriodInHours is a required field MemoryStoreRetentionPeriodInHours *int64 `min:"1" type:"long" required:"true"` // contains filtered or unexported fields }
Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.
func (RetentionProperties) GoString ¶
func (s RetentionProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RetentionProperties) SetMagneticStoreRetentionPeriodInDays ¶
func (s *RetentionProperties) SetMagneticStoreRetentionPeriodInDays(v int64) *RetentionProperties
SetMagneticStoreRetentionPeriodInDays sets the MagneticStoreRetentionPeriodInDays field's value.
func (*RetentionProperties) SetMemoryStoreRetentionPeriodInHours ¶
func (s *RetentionProperties) SetMemoryStoreRetentionPeriodInHours(v int64) *RetentionProperties
SetMemoryStoreRetentionPeriodInHours sets the MemoryStoreRetentionPeriodInHours field's value.
func (RetentionProperties) String ¶
func (s RetentionProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RetentionProperties) Validate ¶
func (s *RetentionProperties) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3Configuration ¶ added in v1.42.12
type S3Configuration struct { // >Bucket name of the customer S3 bucket. BucketName *string `min:"3" type:"string"` // Encryption option for the customer s3 location. Options are S3 server side // encryption with an S3-managed key or KMS managed key. EncryptionOption *string `type:"string" enum:"S3EncryptionOption"` // KMS key id for the customer s3 location when encrypting with a KMS managed // key. KmsKeyId *string `min:"1" type:"string"` // Object key preview for the customer S3 location. ObjectKeyPrefix *string `min:"1" type:"string"` // contains filtered or unexported fields }
Configuration specifing an S3 location.
func (S3Configuration) GoString ¶ added in v1.42.12
func (s S3Configuration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*S3Configuration) SetBucketName ¶ added in v1.42.12
func (s *S3Configuration) SetBucketName(v string) *S3Configuration
SetBucketName sets the BucketName field's value.
func (*S3Configuration) SetEncryptionOption ¶ added in v1.42.12
func (s *S3Configuration) SetEncryptionOption(v string) *S3Configuration
SetEncryptionOption sets the EncryptionOption field's value.
func (*S3Configuration) SetKmsKeyId ¶ added in v1.42.12
func (s *S3Configuration) SetKmsKeyId(v string) *S3Configuration
SetKmsKeyId sets the KmsKeyId field's value.
func (*S3Configuration) SetObjectKeyPrefix ¶ added in v1.42.12
func (s *S3Configuration) SetObjectKeyPrefix(v string) *S3Configuration
SetObjectKeyPrefix sets the ObjectKeyPrefix field's value.
func (S3Configuration) String ¶ added in v1.42.12
func (s S3Configuration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*S3Configuration) Validate ¶ added in v1.42.12
func (s *S3Configuration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
Instance quota of resource exceeded for this account.
func (*ServiceQuotaExceededException) Code ¶
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (*ServiceQuotaExceededException) Error ¶
func (s *ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ServiceQuotaExceededException) Message ¶
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (*ServiceQuotaExceededException) OrigErr ¶
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ServiceQuotaExceededException) RequestID ¶
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ServiceQuotaExceededException) StatusCode ¶
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Table ¶
type Table struct { // The Amazon Resource Name that uniquely identifies this table. Arn *string `type:"string"` // The time when the Timestream table was created. CreationTime *time.Time `type:"timestamp"` // The name of the Timestream database that contains this table. DatabaseName *string `type:"string"` // The time when the Timestream table was last updated. LastUpdatedTime *time.Time `type:"timestamp"` // Contains properties to set on the table when enabling magnetic store writes. MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"` // The retention duration for the memory store and magnetic store. RetentionProperties *RetentionProperties `type:"structure"` // The name of the Timestream table. TableName *string `type:"string"` // The current state of the table: // // * DELETING - The table is being deleted. // // * ACTIVE - The table is ready for use. TableStatus *string `type:"string" enum:"TableStatus"` // contains filtered or unexported fields }
Table represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table.
func (Table) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Table) SetCreationTime ¶
SetCreationTime sets the CreationTime field's value.
func (*Table) SetDatabaseName ¶
SetDatabaseName sets the DatabaseName field's value.
func (*Table) SetLastUpdatedTime ¶
SetLastUpdatedTime sets the LastUpdatedTime field's value.
func (*Table) SetMagneticStoreWriteProperties ¶ added in v1.42.12
func (s *Table) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *Table
SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.
func (*Table) SetRetentionProperties ¶
func (s *Table) SetRetentionProperties(v *RetentionProperties) *Table
SetRetentionProperties sets the RetentionProperties field's value.
func (*Table) SetTableName ¶
SetTableName sets the TableName field's value.
func (*Table) SetTableStatus ¶
SetTableStatus sets the TableStatus field's value.
type Tag ¶
type Tag struct { // The key of the tag. Tag keys are case sensitive. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the tag. Tag values are case-sensitive and can be null. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.
func (Tag) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TagResourceInput ¶
type TagResourceInput struct { // Identifies the Timestream resource to which tags should be added. This value // is an Amazon Resource Name (ARN). // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // The tags to be assigned to the Timestream resource. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) GoString ¶
func (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) SetResourceARN ¶
func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput
SetResourceARN sets the ResourceARN field's value.
func (*TagResourceInput) SetTags ¶
func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) GoString ¶
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException ¶
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
Too many requests were made by a user exceeding service quotas. The request was throttled.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TimestreamWrite ¶
TimestreamWrite provides the API operation methods for making requests to Amazon Timestream Write. See this package's package overview docs for details on the service.
TimestreamWrite 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) *TimestreamWrite
New creates a new instance of the TimestreamWrite 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 TimestreamWrite client from just a session. svc := timestreamwrite.New(mySession) // Create a TimestreamWrite client with additional configuration svc := timestreamwrite.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*TimestreamWrite) CreateDatabase ¶
func (c *TimestreamWrite) CreateDatabase(input *CreateDatabaseInput) (*CreateDatabaseOutput, error)
CreateDatabase API operation for Amazon Timestream Write.
Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to Amazon Web Services managed KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) for more info. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html) for details.
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 Timestream Write's API operation CreateDatabase for usage and error information.
Returned Error Types:
ConflictException Timestream was unable to process this request because it contains resource that already exists.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
ServiceQuotaExceededException Instance quota of resource exceeded for this account.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
InvalidEndpointException The requested endpoint was invalid.
InternalServerException Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateDatabase
func (*TimestreamWrite) CreateDatabaseRequest ¶
func (c *TimestreamWrite) CreateDatabaseRequest(input *CreateDatabaseInput) (req *request.Request, output *CreateDatabaseOutput)
CreateDatabaseRequest generates a "aws/request.Request" representing the client's request for the CreateDatabase 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 CreateDatabase for more information on using the CreateDatabase 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 CreateDatabaseRequest method. req, resp := client.CreateDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateDatabase
func (*TimestreamWrite) CreateDatabaseWithContext ¶
func (c *TimestreamWrite) CreateDatabaseWithContext(ctx aws.Context, input *CreateDatabaseInput, opts ...request.Option) (*CreateDatabaseOutput, error)
CreateDatabaseWithContext is the same as CreateDatabase with the addition of the ability to pass a context and additional request options.
See CreateDatabase 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 (*TimestreamWrite) CreateTable ¶
func (c *TimestreamWrite) CreateTable(input *CreateTableInput) (*CreateTableOutput, error)
CreateTable API operation for Amazon Timestream Write.
The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.
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 Timestream Write's API operation CreateTable for usage and error information.
Returned Error Types:
ConflictException Timestream was unable to process this request because it contains resource that already exists.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ServiceQuotaExceededException Instance quota of resource exceeded for this account.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
InvalidEndpointException The requested endpoint was invalid.
InternalServerException Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable
func (*TimestreamWrite) CreateTableRequest ¶
func (c *TimestreamWrite) CreateTableRequest(input *CreateTableInput) (req *request.Request, output *CreateTableOutput)
CreateTableRequest generates a "aws/request.Request" representing the client's request for the CreateTable 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 CreateTable for more information on using the CreateTable 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 CreateTableRequest method. req, resp := client.CreateTableRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable
func (*TimestreamWrite) CreateTableWithContext ¶
func (c *TimestreamWrite) CreateTableWithContext(ctx aws.Context, input *CreateTableInput, opts ...request.Option) (*CreateTableOutput, error)
CreateTableWithContext is the same as CreateTable with the addition of the ability to pass a context and additional request options.
See CreateTable 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 (*TimestreamWrite) DeleteDatabase ¶
func (c *TimestreamWrite) DeleteDatabase(input *DeleteDatabaseInput) (*DeleteDatabaseOutput, error)
DeleteDatabase API operation for Amazon Timestream Write.
Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time series data from its tables cannot be recovered.
All tables in the database must be deleted first, or a ValidationException error will be thrown.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) for details.
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 Timestream Write's API operation DeleteDatabase for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteDatabase
func (*TimestreamWrite) DeleteDatabaseRequest ¶
func (c *TimestreamWrite) DeleteDatabaseRequest(input *DeleteDatabaseInput) (req *request.Request, output *DeleteDatabaseOutput)
DeleteDatabaseRequest generates a "aws/request.Request" representing the client's request for the DeleteDatabase 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 DeleteDatabase for more information on using the DeleteDatabase 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 DeleteDatabaseRequest method. req, resp := client.DeleteDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteDatabase
func (*TimestreamWrite) DeleteDatabaseWithContext ¶
func (c *TimestreamWrite) DeleteDatabaseWithContext(ctx aws.Context, input *DeleteDatabaseInput, opts ...request.Option) (*DeleteDatabaseOutput, error)
DeleteDatabaseWithContext is the same as DeleteDatabase with the addition of the ability to pass a context and additional request options.
See DeleteDatabase 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 (*TimestreamWrite) DeleteTable ¶
func (c *TimestreamWrite) DeleteTable(input *DeleteTableInput) (*DeleteTableOutput, error)
DeleteTable API operation for Amazon Timestream Write.
Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time series data stored in the table cannot be recovered.
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) for details.
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 Timestream Write's API operation DeleteTable for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
AccessDeniedException You are not authorized to perform this action.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteTable
func (*TimestreamWrite) DeleteTableRequest ¶
func (c *TimestreamWrite) DeleteTableRequest(input *DeleteTableInput) (req *request.Request, output *DeleteTableOutput)
DeleteTableRequest generates a "aws/request.Request" representing the client's request for the DeleteTable 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 DeleteTable for more information on using the DeleteTable 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 DeleteTableRequest method. req, resp := client.DeleteTableRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DeleteTable
func (*TimestreamWrite) DeleteTableWithContext ¶
func (c *TimestreamWrite) DeleteTableWithContext(ctx aws.Context, input *DeleteTableInput, opts ...request.Option) (*DeleteTableOutput, error)
DeleteTableWithContext is the same as DeleteTable with the addition of the ability to pass a context and additional request options.
See DeleteTable 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 (*TimestreamWrite) DescribeDatabase ¶
func (c *TimestreamWrite) DescribeDatabase(input *DescribeDatabaseInput) (*DescribeDatabaseOutput, error)
DescribeDatabase API operation for Amazon Timestream Write.
Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) for details.
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 Timestream Write's API operation DescribeDatabase for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
InternalServerException Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeDatabase
func (*TimestreamWrite) DescribeDatabaseRequest ¶
func (c *TimestreamWrite) DescribeDatabaseRequest(input *DescribeDatabaseInput) (req *request.Request, output *DescribeDatabaseOutput)
DescribeDatabaseRequest generates a "aws/request.Request" representing the client's request for the DescribeDatabase 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 DescribeDatabase for more information on using the DescribeDatabase 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 DescribeDatabaseRequest method. req, resp := client.DescribeDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeDatabase
func (*TimestreamWrite) DescribeDatabaseWithContext ¶
func (c *TimestreamWrite) DescribeDatabaseWithContext(ctx aws.Context, input *DescribeDatabaseInput, opts ...request.Option) (*DescribeDatabaseOutput, error)
DescribeDatabaseWithContext is the same as DescribeDatabase with the addition of the ability to pass a context and additional request options.
See DescribeDatabase 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 (*TimestreamWrite) DescribeEndpoints ¶
func (c *TimestreamWrite) DescribeEndpoints(input *DescribeEndpointsInput) (*DescribeEndpointsOutput, error)
DescribeEndpoints API operation for Amazon Timestream Write.
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream (https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints)
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern (https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).
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 Timestream Write's API operation DescribeEndpoints for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ValidationException Invalid or malformed request.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeEndpoints
func (*TimestreamWrite) DescribeEndpointsRequest ¶
func (c *TimestreamWrite) DescribeEndpointsRequest(input *DescribeEndpointsInput) (req *request.Request, output *DescribeEndpointsOutput)
DescribeEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoints 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 DescribeEndpoints for more information on using the DescribeEndpoints 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 DescribeEndpointsRequest method. req, resp := client.DescribeEndpointsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeEndpoints
func (*TimestreamWrite) DescribeEndpointsWithContext ¶
func (c *TimestreamWrite) DescribeEndpointsWithContext(ctx aws.Context, input *DescribeEndpointsInput, opts ...request.Option) (*DescribeEndpointsOutput, error)
DescribeEndpointsWithContext is the same as DescribeEndpoints with the addition of the ability to pass a context and additional request options.
See DescribeEndpoints 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 (*TimestreamWrite) DescribeTable ¶
func (c *TimestreamWrite) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error)
DescribeTable API operation for Amazon Timestream Write.
Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) for details.
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 Timestream Write's API operation DescribeTable for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
InternalServerException Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable
func (*TimestreamWrite) DescribeTableRequest ¶
func (c *TimestreamWrite) DescribeTableRequest(input *DescribeTableInput) (req *request.Request, output *DescribeTableOutput)
DescribeTableRequest generates a "aws/request.Request" representing the client's request for the DescribeTable 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 DescribeTable for more information on using the DescribeTable 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 DescribeTableRequest method. req, resp := client.DescribeTableRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable
func (*TimestreamWrite) DescribeTableWithContext ¶
func (c *TimestreamWrite) DescribeTableWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.Option) (*DescribeTableOutput, error)
DescribeTableWithContext is the same as DescribeTable with the addition of the ability to pass a context and additional request options.
See DescribeTable 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 (*TimestreamWrite) ListDatabases ¶
func (c *TimestreamWrite) ListDatabases(input *ListDatabasesInput) (*ListDatabasesOutput, error)
ListDatabases API operation for Amazon Timestream Write.
Returns a list of your Timestream databases. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) for details.
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 Timestream Write's API operation ListDatabases for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListDatabases
func (*TimestreamWrite) ListDatabasesPages ¶
func (c *TimestreamWrite) ListDatabasesPages(input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool) error
ListDatabasesPages iterates over the pages of a ListDatabases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDatabases method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDatabases operation. pageNum := 0 err := client.ListDatabasesPages(params, func(page *timestreamwrite.ListDatabasesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*TimestreamWrite) ListDatabasesPagesWithContext ¶
func (c *TimestreamWrite) ListDatabasesPagesWithContext(ctx aws.Context, input *ListDatabasesInput, fn func(*ListDatabasesOutput, bool) bool, opts ...request.Option) error
ListDatabasesPagesWithContext same as ListDatabasesPages except it takes a Context and allows setting request options on the pages.
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 (*TimestreamWrite) ListDatabasesRequest ¶
func (c *TimestreamWrite) ListDatabasesRequest(input *ListDatabasesInput) (req *request.Request, output *ListDatabasesOutput)
ListDatabasesRequest generates a "aws/request.Request" representing the client's request for the ListDatabases 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 ListDatabases for more information on using the ListDatabases 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 ListDatabasesRequest method. req, resp := client.ListDatabasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListDatabases
func (*TimestreamWrite) ListDatabasesWithContext ¶
func (c *TimestreamWrite) ListDatabasesWithContext(ctx aws.Context, input *ListDatabasesInput, opts ...request.Option) (*ListDatabasesOutput, error)
ListDatabasesWithContext is the same as ListDatabases with the addition of the ability to pass a context and additional request options.
See ListDatabases 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 (*TimestreamWrite) ListTables ¶
func (c *TimestreamWrite) ListTables(input *ListTablesInput) (*ListTablesOutput, error)
ListTables API operation for Amazon Timestream Write.
A list of tables, along with the name, status and retention properties of each table. See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) for details.
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 Timestream Write's API operation ListTables for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
AccessDeniedException You are not authorized to perform this action.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables
func (*TimestreamWrite) ListTablesPages ¶
func (c *TimestreamWrite) ListTablesPages(input *ListTablesInput, fn func(*ListTablesOutput, bool) bool) error
ListTablesPages iterates over the pages of a ListTables operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTables method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTables operation. pageNum := 0 err := client.ListTablesPages(params, func(page *timestreamwrite.ListTablesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*TimestreamWrite) ListTablesPagesWithContext ¶
func (c *TimestreamWrite) ListTablesPagesWithContext(ctx aws.Context, input *ListTablesInput, fn func(*ListTablesOutput, bool) bool, opts ...request.Option) error
ListTablesPagesWithContext same as ListTablesPages except it takes a Context and allows setting request options on the pages.
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 (*TimestreamWrite) ListTablesRequest ¶
func (c *TimestreamWrite) ListTablesRequest(input *ListTablesInput) (req *request.Request, output *ListTablesOutput)
ListTablesRequest generates a "aws/request.Request" representing the client's request for the ListTables 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 ListTables for more information on using the ListTables 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 ListTablesRequest method. req, resp := client.ListTablesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables
func (*TimestreamWrite) ListTablesWithContext ¶
func (c *TimestreamWrite) ListTablesWithContext(ctx aws.Context, input *ListTablesInput, opts ...request.Option) (*ListTablesOutput, error)
ListTablesWithContext is the same as ListTables with the addition of the ability to pass a context and additional request options.
See ListTables 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 (*TimestreamWrite) ListTagsForResource ¶
func (c *TimestreamWrite) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Timestream Write.
List all tags on a Timestream resource.
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 Timestream Write's API operation ListTagsForResource for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTagsForResource
func (*TimestreamWrite) ListTagsForResourceRequest ¶
func (c *TimestreamWrite) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTagsForResource
func (*TimestreamWrite) ListTagsForResourceWithContext ¶
func (c *TimestreamWrite) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource 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 (*TimestreamWrite) TagResource ¶
func (c *TimestreamWrite) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for Amazon Timestream Write.
Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
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 Timestream Write's API operation TagResource for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ServiceQuotaExceededException Instance quota of resource exceeded for this account.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/TagResource
func (*TimestreamWrite) TagResourceRequest ¶
func (c *TimestreamWrite) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/TagResource
func (*TimestreamWrite) TagResourceWithContext ¶
func (c *TimestreamWrite) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource 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 (*TimestreamWrite) UntagResource ¶
func (c *TimestreamWrite) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for Amazon Timestream Write.
Removes the association of tags from a Timestream resource.
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 Timestream Write's API operation UntagResource for usage and error information.
Returned Error Types:
ValidationException Invalid or malformed request.
ServiceQuotaExceededException Instance quota of resource exceeded for this account.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UntagResource
func (*TimestreamWrite) UntagResourceRequest ¶
func (c *TimestreamWrite) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UntagResource
func (*TimestreamWrite) UntagResourceWithContext ¶
func (c *TimestreamWrite) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource 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 (*TimestreamWrite) UpdateDatabase ¶
func (c *TimestreamWrite) UpdateDatabase(input *UpdateDatabaseInput) (*UpdateDatabaseOutput, error)
UpdateDatabase API operation for Amazon Timestream Write.
Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins.
See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) for details.
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 Timestream Write's API operation UpdateDatabase for usage and error information.
Returned Error Types:
ValidationException Invalid or malformed request.
AccessDeniedException You are not authorized to perform this action.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ServiceQuotaExceededException Instance quota of resource exceeded for this account.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
InternalServerException Timestream was unable to fully process this request because of an internal server error.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateDatabase
func (*TimestreamWrite) UpdateDatabaseRequest ¶
func (c *TimestreamWrite) UpdateDatabaseRequest(input *UpdateDatabaseInput) (req *request.Request, output *UpdateDatabaseOutput)
UpdateDatabaseRequest generates a "aws/request.Request" representing the client's request for the UpdateDatabase 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 UpdateDatabase for more information on using the UpdateDatabase 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 UpdateDatabaseRequest method. req, resp := client.UpdateDatabaseRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateDatabase
func (*TimestreamWrite) UpdateDatabaseWithContext ¶
func (c *TimestreamWrite) UpdateDatabaseWithContext(ctx aws.Context, input *UpdateDatabaseInput, opts ...request.Option) (*UpdateDatabaseOutput, error)
UpdateDatabaseWithContext is the same as UpdateDatabase with the addition of the ability to pass a context and additional request options.
See UpdateDatabase 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 (*TimestreamWrite) UpdateTable ¶
func (c *TimestreamWrite) UpdateTable(input *UpdateTableInput) (*UpdateTableOutput, error)
UpdateTable API operation for Amazon Timestream Write.
Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.
See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) for details.
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 Timestream Write's API operation UpdateTable for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
AccessDeniedException You are not authorized to perform this action.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable
func (*TimestreamWrite) UpdateTableRequest ¶
func (c *TimestreamWrite) UpdateTableRequest(input *UpdateTableInput) (req *request.Request, output *UpdateTableOutput)
UpdateTableRequest generates a "aws/request.Request" representing the client's request for the UpdateTable 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 UpdateTable for more information on using the UpdateTable 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 UpdateTableRequest method. req, resp := client.UpdateTableRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable
func (*TimestreamWrite) UpdateTableWithContext ¶
func (c *TimestreamWrite) UpdateTableWithContext(ctx aws.Context, input *UpdateTableInput, opts ...request.Option) (*UpdateTableOutput, error)
UpdateTableWithContext is the same as UpdateTable with the addition of the ability to pass a context and additional request options.
See UpdateTable 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 (*TimestreamWrite) WriteRecords ¶
func (c *TimestreamWrite) WriteRecords(input *WriteRecordsInput) (*WriteRecordsOutput, error)
WriteRecords API operation for Amazon Timestream Write.
The WriteRecords operation enables you to write your time series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you with a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream support eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html).
See code sample (https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) for details.
Upserts ¶
You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when not specified for the record in the request. Timestream will update an existing record’s measure value along with its Version upon receiving a write request with a higher Version number for that record. Upon receiving an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases.
For example, suppose you write a new record without indicating Version in the request. Timestream will store this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException.
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 Timestream Write's API operation WriteRecords for usage and error information.
Returned Error Types:
InternalServerException Timestream was unable to fully process this request because of an internal server error.
ThrottlingException Too many requests were made by a user exceeding service quotas. The request was throttled.
ValidationException Invalid or malformed request.
ResourceNotFoundException The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
AccessDeniedException You are not authorized to perform this action.
RejectedRecordsException WriteRecords would throw this exception in the following cases:
Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but: Measure values are different Version is not present in the request or the value of version in the new record is equal to or lower than the existing value In this case, if Timestream rejects data, the ExistingVersion field in the RejectedRecords response will indicate the current record’s version. To force an update, you can resend the request with a version for the record set to a value greater than the ExistingVersion.
Records with timestamps that lie outside the retention duration of the memory store
Records with dimensions or measures that exceed the Timestream defined limits.
For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Timestream Developer Guide.
InvalidEndpointException The requested endpoint was invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords
func (*TimestreamWrite) WriteRecordsRequest ¶
func (c *TimestreamWrite) WriteRecordsRequest(input *WriteRecordsInput) (req *request.Request, output *WriteRecordsOutput)
WriteRecordsRequest generates a "aws/request.Request" representing the client's request for the WriteRecords 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 WriteRecords for more information on using the WriteRecords 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 WriteRecordsRequest method. req, resp := client.WriteRecordsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords
func (*TimestreamWrite) WriteRecordsWithContext ¶
func (c *TimestreamWrite) WriteRecordsWithContext(ctx aws.Context, input *WriteRecordsInput, opts ...request.Option) (*WriteRecordsOutput, error)
WriteRecordsWithContext is the same as WriteRecords with the addition of the ability to pass a context and additional request options.
See WriteRecords 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 UntagResourceInput ¶
type UntagResourceInput struct { // The Timestream resource that the tags will be removed from. This value is // an Amazon Resource Name (ARN). // // ResourceARN is a required field ResourceARN *string `min:"1" type:"string" required:"true"` // A list of tags keys. Existing tags of the resource whose keys are members // of this list will be removed from the Timestream resource. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) GoString ¶
func (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) SetResourceARN ¶
func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput
SetResourceARN sets the ResourceARN field's value.
func (*UntagResourceInput) SetTagKeys ¶
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) GoString ¶
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateDatabaseInput ¶
type UpdateDatabaseInput struct { // The name of the database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // The identifier of the new KMS key (KmsKeyId) to be used to encrypt the data // stored in the database. If the KmsKeyId currently registered with the database // is the same as the KmsKeyId in the request, there will not be any update. // // You can specify the KmsKeyId using any of the following: // // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // * Alias name: alias/ExampleAlias // // * Alias ARN: arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias // // KmsKeyId is a required field KmsKeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateDatabaseInput) GoString ¶
func (s UpdateDatabaseInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateDatabaseInput) SetDatabaseName ¶
func (s *UpdateDatabaseInput) SetDatabaseName(v string) *UpdateDatabaseInput
SetDatabaseName sets the DatabaseName field's value.
func (*UpdateDatabaseInput) SetKmsKeyId ¶
func (s *UpdateDatabaseInput) SetKmsKeyId(v string) *UpdateDatabaseInput
SetKmsKeyId sets the KmsKeyId field's value.
func (UpdateDatabaseInput) String ¶
func (s UpdateDatabaseInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateDatabaseInput) Validate ¶
func (s *UpdateDatabaseInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDatabaseOutput ¶
type UpdateDatabaseOutput struct { // A top level container for a table. Databases and tables are the fundamental // management concepts in Amazon Timestream. All tables in a database are encrypted // with the same KMS key. Database *Database `type:"structure"` // contains filtered or unexported fields }
func (UpdateDatabaseOutput) GoString ¶
func (s UpdateDatabaseOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateDatabaseOutput) SetDatabase ¶
func (s *UpdateDatabaseOutput) SetDatabase(v *Database) *UpdateDatabaseOutput
SetDatabase sets the Database field's value.
func (UpdateDatabaseOutput) String ¶
func (s UpdateDatabaseOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateTableInput ¶
type UpdateTableInput struct { // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // Contains properties to set on the table when enabling magnetic store writes. MagneticStoreWriteProperties *MagneticStoreWriteProperties `type:"structure"` // The retention duration of the memory store and the magnetic store. RetentionProperties *RetentionProperties `type:"structure"` // The name of the Timestream table. // // TableName is a required field TableName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateTableInput) GoString ¶
func (s UpdateTableInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateTableInput) SetDatabaseName ¶
func (s *UpdateTableInput) SetDatabaseName(v string) *UpdateTableInput
SetDatabaseName sets the DatabaseName field's value.
func (*UpdateTableInput) SetMagneticStoreWriteProperties ¶ added in v1.42.12
func (s *UpdateTableInput) SetMagneticStoreWriteProperties(v *MagneticStoreWriteProperties) *UpdateTableInput
SetMagneticStoreWriteProperties sets the MagneticStoreWriteProperties field's value.
func (*UpdateTableInput) SetRetentionProperties ¶
func (s *UpdateTableInput) SetRetentionProperties(v *RetentionProperties) *UpdateTableInput
SetRetentionProperties sets the RetentionProperties field's value.
func (*UpdateTableInput) SetTableName ¶
func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput
SetTableName sets the TableName field's value.
func (UpdateTableInput) String ¶
func (s UpdateTableInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateTableInput) Validate ¶
func (s *UpdateTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateTableOutput ¶
type UpdateTableOutput struct { // The updated Timestream table. Table *Table `type:"structure"` // contains filtered or unexported fields }
func (UpdateTableOutput) GoString ¶
func (s UpdateTableOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UpdateTableOutput) SetTable ¶
func (s *UpdateTableOutput) SetTable(v *Table) *UpdateTableOutput
SetTable sets the Table field's value.
func (UpdateTableOutput) String ¶
func (s UpdateTableOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException ¶
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
Invalid or malformed request.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type WriteRecordsInput ¶
type WriteRecordsInput struct { // A record containing the common measure, dimension, time, and version attributes // shared across all the records in the request. The measure and dimension attributes // specified will be merged with the measure and dimension attributes in the // records object when the data is written into Timestream. Dimensions may not // overlap, or a ValidationException will be thrown. In other words, a record // must contain dimensions with unique names. CommonAttributes *Record `type:"structure"` // The name of the Timestream database. // // DatabaseName is a required field DatabaseName *string `type:"string" required:"true"` // An array of records containing the unique measure, dimension, time, and version // attributes for each time series data point. // // Records is a required field Records []*Record `min:"1" type:"list" required:"true"` // The name of the Timestream table. // // TableName is a required field TableName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (WriteRecordsInput) GoString ¶
func (s WriteRecordsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*WriteRecordsInput) SetCommonAttributes ¶
func (s *WriteRecordsInput) SetCommonAttributes(v *Record) *WriteRecordsInput
SetCommonAttributes sets the CommonAttributes field's value.
func (*WriteRecordsInput) SetDatabaseName ¶
func (s *WriteRecordsInput) SetDatabaseName(v string) *WriteRecordsInput
SetDatabaseName sets the DatabaseName field's value.
func (*WriteRecordsInput) SetRecords ¶
func (s *WriteRecordsInput) SetRecords(v []*Record) *WriteRecordsInput
SetRecords sets the Records field's value.
func (*WriteRecordsInput) SetTableName ¶
func (s *WriteRecordsInput) SetTableName(v string) *WriteRecordsInput
SetTableName sets the TableName field's value.
func (WriteRecordsInput) String ¶
func (s WriteRecordsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*WriteRecordsInput) Validate ¶
func (s *WriteRecordsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WriteRecordsOutput ¶
type WriteRecordsOutput struct { // Information on the records ingested by this request. RecordsIngested *RecordsIngested `type:"structure"` // contains filtered or unexported fields }
func (WriteRecordsOutput) GoString ¶
func (s WriteRecordsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*WriteRecordsOutput) SetRecordsIngested ¶ added in v1.42.12
func (s *WriteRecordsOutput) SetRecordsIngested(v *RecordsIngested) *WriteRecordsOutput
SetRecordsIngested sets the RecordsIngested field's value.
func (WriteRecordsOutput) String ¶
func (s WriteRecordsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
Directories ¶
Path | Synopsis |
---|---|
Package timestreamwriteiface provides an interface to enable mocking the Amazon Timestream Write service client for testing your code.
|
Package timestreamwriteiface provides an interface to enable mocking the Amazon Timestream Write service client for testing your code. |