timestreaminfluxdb

package
v1.51.23 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package timestreaminfluxdb provides the client and types for making API requests to Timestream InfluxDB.

Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.

See https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27 for more information on this service.

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

Using the Client

To contact Timestream InfluxDB 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 Timestream InfluxDB client TimestreamInfluxDB for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/timestreaminfluxdb/#New

Index

Constants

View Source
const (
	// DbInstanceTypeDbInfluxMedium is a DbInstanceType enum value
	DbInstanceTypeDbInfluxMedium = "db.influx.medium"

	// DbInstanceTypeDbInfluxLarge is a DbInstanceType enum value
	DbInstanceTypeDbInfluxLarge = "db.influx.large"

	// DbInstanceTypeDbInfluxXlarge is a DbInstanceType enum value
	DbInstanceTypeDbInfluxXlarge = "db.influx.xlarge"

	// DbInstanceTypeDbInflux2xlarge is a DbInstanceType enum value
	DbInstanceTypeDbInflux2xlarge = "db.influx.2xlarge"

	// DbInstanceTypeDbInflux4xlarge is a DbInstanceType enum value
	DbInstanceTypeDbInflux4xlarge = "db.influx.4xlarge"

	// DbInstanceTypeDbInflux8xlarge is a DbInstanceType enum value
	DbInstanceTypeDbInflux8xlarge = "db.influx.8xlarge"

	// DbInstanceTypeDbInflux12xlarge is a DbInstanceType enum value
	DbInstanceTypeDbInflux12xlarge = "db.influx.12xlarge"

	// DbInstanceTypeDbInflux16xlarge is a DbInstanceType enum value
	DbInstanceTypeDbInflux16xlarge = "db.influx.16xlarge"
)
View Source
const (
	// DbStorageTypeInfluxIoincludedT1 is a DbStorageType enum value
	DbStorageTypeInfluxIoincludedT1 = "InfluxIOIncludedT1"

	// DbStorageTypeInfluxIoincludedT2 is a DbStorageType enum value
	DbStorageTypeInfluxIoincludedT2 = "InfluxIOIncludedT2"

	// DbStorageTypeInfluxIoincludedT3 is a DbStorageType enum value
	DbStorageTypeInfluxIoincludedT3 = "InfluxIOIncludedT3"
)
View Source
const (
	// DeploymentTypeSingleAz is a DeploymentType enum value
	DeploymentTypeSingleAz = "SINGLE_AZ"

	// DeploymentTypeWithMultiazStandby is a DeploymentType enum value
	DeploymentTypeWithMultiazStandby = "WITH_MULTIAZ_STANDBY"
)
View Source
const (
	// LogLevelDebug is a LogLevel enum value
	LogLevelDebug = "debug"

	// LogLevelInfo is a LogLevel enum value
	LogLevelInfo = "info"

	// LogLevelError is a LogLevel enum value
	LogLevelError = "error"
)
View Source
const (
	// StatusCreating is a Status enum value
	StatusCreating = "CREATING"

	// StatusAvailable is a Status enum value
	StatusAvailable = "AVAILABLE"

	// StatusDeleting is a Status enum value
	StatusDeleting = "DELETING"

	// StatusModifying is a Status enum value
	StatusModifying = "MODIFYING"

	// StatusUpdating is a Status enum value
	StatusUpdating = "UPDATING"

	// StatusDeleted is a Status enum value
	StatusDeleted = "DELETED"

	// StatusFailed is a Status enum value
	StatusFailed = "FAILED"
)
View Source
const (
	// TracingTypeLog is a TracingType enum value
	TracingTypeLog = "log"

	// TracingTypeJaeger is a TracingType enum value
	TracingTypeJaeger = "jaeger"
)
View Source
const (
	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request conflicts with an existing resource in Timestream for InfluxDB.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request processing has failed because of an unknown error, exception
	// or failure.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource was not found or does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request exceeds the service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by Timestream for InfluxDB.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Timestream InfluxDB" // Name of service.
	EndpointsID = "timestream-influxdb" // ID to lookup a service endpoint with.
	ServiceID   = "Timestream InfluxDB" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func DbInstanceType_Values

func DbInstanceType_Values() []string

DbInstanceType_Values returns all elements of the DbInstanceType enum

func DbStorageType_Values

func DbStorageType_Values() []string

DbStorageType_Values returns all elements of the DbStorageType enum

func DeploymentType_Values

func DeploymentType_Values() []string

DeploymentType_Values returns all elements of the DeploymentType enum

func LogLevel_Values

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func Status_Values

func Status_Values() []string

Status_Values returns all elements of the Status enum

func TracingType_Values

func TracingType_Values() []string

TracingType_Values returns all elements of the TracingType enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException

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

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

You do not have sufficient access to perform this action.

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"`

	// The identifier for the Timestream for InfluxDB resource associated with the
	// request.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of Timestream for InfluxDB resource associated with the request.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request conflicts with an existing resource in Timestream for InfluxDB.

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 CreateDbInstanceInput

type CreateDbInstanceInput struct {

	// The amount of storage to allocate for your DB storage type in GiB (gibibytes).
	//
	// AllocatedStorage is a required field
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer" required:"true"`

	// The name of the initial InfluxDB bucket. All InfluxDB data is stored in a
	// bucket. A bucket combines the concept of a database and a retention period
	// (the duration of time that each data point persists). A bucket belongs to
	// an organization.
	Bucket *string `locationName:"bucket" min:"2" type:"string"`

	// The Timestream for InfluxDB DB instance type to run InfluxDB on.
	//
	// DbInstanceType is a required field
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" required:"true" enum:"DbInstanceType"`

	// The id of the DB parameter group to assign to your DB instance. DB parameter
	// groups specify how the database is configured. For example, DB parameter
	// groups can specify the limit for query concurrency.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
	//
	// You can choose between 3 different types of provisioned Influx IOPS included
	// storage according to your workloads requirements:
	//
	//    * Influx IO Included 3000 IOPS
	//
	//    * Influx IO Included 12000 IOPS
	//
	//    * Influx IO Included 16000 IOPS
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Specifies whether the DB instance will be deployed as a standalone instance
	// or with a Multi-AZ standby for high availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// Configuration for sending InfluxDB engine logs to a specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`

	// The name that uniquely identifies the DB instance when interacting with the
	// Amazon Timestream for InfluxDB API and CLI commands. This name will also
	// be a prefix included in the endpoint. DB instance names must be unique per
	// customer and per region.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The name of the initial organization for the initial admin user in InfluxDB.
	// An InfluxDB organization is a workspace for a group of users.
	Organization *string `locationName:"organization" min:"1" type:"string"`

	// The password of the initial admin user created in InfluxDB. This password
	// will allow you to access the InfluxDB UI to perform various administrative
	// tasks and also use the InfluxDB CLI to create an operator token. These attributes
	// will be stored in a Secret created in AWS SecretManager in your account.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateDbInstanceInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `locationName:"password" min:"8" type:"string" required:"true" sensitive:"true"`

	// Configures the DB instance with a public IP to facilitate access.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// A list of key-value pairs to associate with the DB instance.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`

	// The username of the initial admin user created in InfluxDB. Must start with
	// a letter and can't end with a hyphen or contain two consecutive hyphens.
	// For example, my-user1. This username will allow you to access the InfluxDB
	// UI to perform various administrative tasks and also use the InfluxDB CLI
	// to create an operator token. These attributes will be stored in a Secret
	// created in Amazon Secrets Manager in your account.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateDbInstanceInput's
	// String and GoString methods.
	Username *string `locationName:"username" min:"1" type:"string" sensitive:"true"`

	// A list of VPC security group IDs to associate with the DB instance.
	//
	// VpcSecurityGroupIds is a required field
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" min:"1" type:"list" required:"true"`

	// A list of VPC subnet IDs to associate with the DB instance. Provide at least
	// two VPC subnet IDs in different availability zones when deploying with a
	// Multi-AZ standby.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `locationName:"vpcSubnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDbInstanceInput) GoString

func (s CreateDbInstanceInput) 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 (*CreateDbInstanceInput) SetAllocatedStorage

func (s *CreateDbInstanceInput) SetAllocatedStorage(v int64) *CreateDbInstanceInput

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*CreateDbInstanceInput) SetBucket

SetBucket sets the Bucket field's value.

func (*CreateDbInstanceInput) SetDbInstanceType

func (s *CreateDbInstanceInput) SetDbInstanceType(v string) *CreateDbInstanceInput

SetDbInstanceType sets the DbInstanceType field's value.

func (*CreateDbInstanceInput) SetDbParameterGroupIdentifier

func (s *CreateDbInstanceInput) SetDbParameterGroupIdentifier(v string) *CreateDbInstanceInput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*CreateDbInstanceInput) SetDbStorageType

func (s *CreateDbInstanceInput) SetDbStorageType(v string) *CreateDbInstanceInput

SetDbStorageType sets the DbStorageType field's value.

func (*CreateDbInstanceInput) SetDeploymentType

func (s *CreateDbInstanceInput) SetDeploymentType(v string) *CreateDbInstanceInput

SetDeploymentType sets the DeploymentType field's value.

func (*CreateDbInstanceInput) SetLogDeliveryConfiguration

func (s *CreateDbInstanceInput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *CreateDbInstanceInput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (*CreateDbInstanceInput) SetName

SetName sets the Name field's value.

func (*CreateDbInstanceInput) SetOrganization

func (s *CreateDbInstanceInput) SetOrganization(v string) *CreateDbInstanceInput

SetOrganization sets the Organization field's value.

func (*CreateDbInstanceInput) SetPassword

SetPassword sets the Password field's value.

func (*CreateDbInstanceInput) SetPubliclyAccessible

func (s *CreateDbInstanceInput) SetPubliclyAccessible(v bool) *CreateDbInstanceInput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateDbInstanceInput) SetTags

SetTags sets the Tags field's value.

func (*CreateDbInstanceInput) SetUsername

SetUsername sets the Username field's value.

func (*CreateDbInstanceInput) SetVpcSecurityGroupIds

func (s *CreateDbInstanceInput) SetVpcSecurityGroupIds(v []*string) *CreateDbInstanceInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*CreateDbInstanceInput) SetVpcSubnetIds

func (s *CreateDbInstanceInput) SetVpcSubnetIds(v []*string) *CreateDbInstanceInput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (CreateDbInstanceInput) String

func (s CreateDbInstanceInput) 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 (*CreateDbInstanceInput) Validate

func (s *CreateDbInstanceInput) Validate() error

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

type CreateDbInstanceOutput

type CreateDbInstanceOutput struct {

	// The amount of storage allocated for your DB storage type (in gibibytes).
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The Availability Zone in which the DB instance resides.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The Timestream for InfluxDB instance type that InfluxDB runs on.
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" enum:"DbInstanceType"`

	// The id of the DB parameter group assigned to your DB instance.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or
	// with a MultiAZ Standby for High availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing
	// the initial InfluxDB authorization parameters. The secret value is a JSON
	// formatted key-value pair holding InfluxDB authorization values: organization,
	// bucket, username, and password.
	InfluxAuthParametersSecretArn *string `locationName:"influxAuthParametersSecretArn" type:"string"`

	// Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`

	// The customer-supplied name that uniquely identifies the DB instance when
	// interacting with the Amazon Timestream for InfluxDB API and CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Indicates if the DB instance has a public IP to facilitate access.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// The Availability Zone in which the standby instance is located when deploying
	// with a MultiAZ standby instance.
	SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"`

	// The status of the DB instance.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// A list of VPC security group IDs associated with the DB instance.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" min:"1" type:"list"`

	// A list of VPC subnet IDs associated with the DB instance.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `locationName:"vpcSubnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDbInstanceOutput) GoString

func (s CreateDbInstanceOutput) 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 (*CreateDbInstanceOutput) SetAllocatedStorage

func (s *CreateDbInstanceOutput) SetAllocatedStorage(v int64) *CreateDbInstanceOutput

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*CreateDbInstanceOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateDbInstanceOutput) SetAvailabilityZone

func (s *CreateDbInstanceOutput) SetAvailabilityZone(v string) *CreateDbInstanceOutput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDbInstanceOutput) SetDbInstanceType

func (s *CreateDbInstanceOutput) SetDbInstanceType(v string) *CreateDbInstanceOutput

SetDbInstanceType sets the DbInstanceType field's value.

func (*CreateDbInstanceOutput) SetDbParameterGroupIdentifier

func (s *CreateDbInstanceOutput) SetDbParameterGroupIdentifier(v string) *CreateDbInstanceOutput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*CreateDbInstanceOutput) SetDbStorageType

func (s *CreateDbInstanceOutput) SetDbStorageType(v string) *CreateDbInstanceOutput

SetDbStorageType sets the DbStorageType field's value.

func (*CreateDbInstanceOutput) SetDeploymentType

func (s *CreateDbInstanceOutput) SetDeploymentType(v string) *CreateDbInstanceOutput

SetDeploymentType sets the DeploymentType field's value.

func (*CreateDbInstanceOutput) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*CreateDbInstanceOutput) SetId

SetId sets the Id field's value.

func (*CreateDbInstanceOutput) SetInfluxAuthParametersSecretArn

func (s *CreateDbInstanceOutput) SetInfluxAuthParametersSecretArn(v string) *CreateDbInstanceOutput

SetInfluxAuthParametersSecretArn sets the InfluxAuthParametersSecretArn field's value.

func (*CreateDbInstanceOutput) SetLogDeliveryConfiguration

func (s *CreateDbInstanceOutput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *CreateDbInstanceOutput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (*CreateDbInstanceOutput) SetName

SetName sets the Name field's value.

func (*CreateDbInstanceOutput) SetPubliclyAccessible

func (s *CreateDbInstanceOutput) SetPubliclyAccessible(v bool) *CreateDbInstanceOutput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateDbInstanceOutput) SetSecondaryAvailabilityZone

func (s *CreateDbInstanceOutput) SetSecondaryAvailabilityZone(v string) *CreateDbInstanceOutput

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*CreateDbInstanceOutput) SetStatus

SetStatus sets the Status field's value.

func (*CreateDbInstanceOutput) SetVpcSecurityGroupIds

func (s *CreateDbInstanceOutput) SetVpcSecurityGroupIds(v []*string) *CreateDbInstanceOutput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*CreateDbInstanceOutput) SetVpcSubnetIds

func (s *CreateDbInstanceOutput) SetVpcSubnetIds(v []*string) *CreateDbInstanceOutput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (CreateDbInstanceOutput) String

func (s CreateDbInstanceOutput) 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 CreateDbParameterGroupInput

type CreateDbParameterGroupInput struct {

	// A description of the DB parameter group.
	Description *string `locationName:"description" type:"string"`

	// The name of the DB parameter group. The name must be unique per customer
	// and per region.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// A list of the parameters that comprise the DB parameter group.
	Parameters *Parameters `locationName:"parameters" type:"structure"`

	// A list of key-value pairs to associate with the DB parameter group.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateDbParameterGroupInput) GoString

func (s CreateDbParameterGroupInput) 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 (*CreateDbParameterGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateDbParameterGroupInput) SetName

SetName sets the Name field's value.

func (*CreateDbParameterGroupInput) SetParameters

SetParameters sets the Parameters field's value.

func (*CreateDbParameterGroupInput) SetTags

SetTags sets the Tags field's value.

func (CreateDbParameterGroupInput) 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 (*CreateDbParameterGroupInput) Validate

func (s *CreateDbParameterGroupInput) Validate() error

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

type CreateDbParameterGroupOutput

type CreateDbParameterGroupOutput struct {

	// The Amazon Resource Name (ARM) of the DB parameter group.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The description of the DB parameter group.
	Description *string `locationName:"description" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The customer-supplied name that uniquely identifies the DB parameter group
	// when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// A list of the parameters that comprise the DB parameter group.
	Parameters *Parameters `locationName:"parameters" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDbParameterGroupOutput) GoString

func (s CreateDbParameterGroupOutput) 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 (*CreateDbParameterGroupOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateDbParameterGroupOutput) SetDescription

SetDescription sets the Description field's value.

func (*CreateDbParameterGroupOutput) SetId

SetId sets the Id field's value.

func (*CreateDbParameterGroupOutput) SetName

SetName sets the Name field's value.

func (*CreateDbParameterGroupOutput) SetParameters

SetParameters sets the Parameters field's value.

func (CreateDbParameterGroupOutput) 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 DbInstanceSummary

type DbInstanceSummary struct {

	// The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The Timestream for InfluxDB instance type to run InfluxDB on.
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" enum:"DbInstanceType"`

	// The storage type for your DB instance.
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Single-Instance or with a MultiAZ Standby for High availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// The service-generated unique identifier of the DB instance.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// This customer-supplied name uniquely identifies the DB instance when interacting
	// with the Amazon Timestream for InfluxDB API and AWS CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The status of the DB instance.
	Status *string `locationName:"status" type:"string" enum:"Status"`
	// contains filtered or unexported fields
}

Contains a summary of a DB instance.

func (DbInstanceSummary) GoString

func (s DbInstanceSummary) 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 (*DbInstanceSummary) SetAllocatedStorage

func (s *DbInstanceSummary) SetAllocatedStorage(v int64) *DbInstanceSummary

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DbInstanceSummary) SetArn

SetArn sets the Arn field's value.

func (*DbInstanceSummary) SetDbInstanceType

func (s *DbInstanceSummary) SetDbInstanceType(v string) *DbInstanceSummary

SetDbInstanceType sets the DbInstanceType field's value.

func (*DbInstanceSummary) SetDbStorageType

func (s *DbInstanceSummary) SetDbStorageType(v string) *DbInstanceSummary

SetDbStorageType sets the DbStorageType field's value.

func (*DbInstanceSummary) SetDeploymentType

func (s *DbInstanceSummary) SetDeploymentType(v string) *DbInstanceSummary

SetDeploymentType sets the DeploymentType field's value.

func (*DbInstanceSummary) SetEndpoint

func (s *DbInstanceSummary) SetEndpoint(v string) *DbInstanceSummary

SetEndpoint sets the Endpoint field's value.

func (*DbInstanceSummary) SetId

SetId sets the Id field's value.

func (*DbInstanceSummary) SetName

SetName sets the Name field's value.

func (*DbInstanceSummary) SetStatus

func (s *DbInstanceSummary) SetStatus(v string) *DbInstanceSummary

SetStatus sets the Status field's value.

func (DbInstanceSummary) String

func (s DbInstanceSummary) 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 DbParameterGroupSummary

type DbParameterGroupSummary struct {

	// The Amazon Resource Name (ARN) of the DB parameter group.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// A description of the DB parameter group.
	Description *string `locationName:"description" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// This customer-supplied name uniquely identifies the parameter group.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of a DB parameter group.

func (DbParameterGroupSummary) GoString

func (s DbParameterGroupSummary) 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 (*DbParameterGroupSummary) SetArn

SetArn sets the Arn field's value.

func (*DbParameterGroupSummary) SetDescription

SetDescription sets the Description field's value.

func (*DbParameterGroupSummary) SetId

SetId sets the Id field's value.

func (*DbParameterGroupSummary) SetName

SetName sets the Name field's value.

func (DbParameterGroupSummary) String

func (s DbParameterGroupSummary) 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 DeleteDbInstanceInput

type DeleteDbInstanceInput struct {

	// The id of the DB instance.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDbInstanceInput) GoString

func (s DeleteDbInstanceInput) 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 (*DeleteDbInstanceInput) SetIdentifier

func (s *DeleteDbInstanceInput) SetIdentifier(v string) *DeleteDbInstanceInput

SetIdentifier sets the Identifier field's value.

func (DeleteDbInstanceInput) String

func (s DeleteDbInstanceInput) 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 (*DeleteDbInstanceInput) Validate

func (s *DeleteDbInstanceInput) Validate() error

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

type DeleteDbInstanceOutput

type DeleteDbInstanceOutput struct {

	// The amount of storage allocated for your DB storage type (in gibibytes).
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The Availability Zone in which the DB instance resides.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The Timestream for InfluxDB instance type that InfluxDB runs on.
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" enum:"DbInstanceType"`

	// The id of the DB parameter group assigned to your DB instance.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or
	// with a MultiAZ Standby for High availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing
	// the initial InfluxDB authorization parameters. The secret value is a JSON
	// formatted key-value pair holding InfluxDB authorization values: organization,
	// bucket, username, and password.
	InfluxAuthParametersSecretArn *string `locationName:"influxAuthParametersSecretArn" type:"string"`

	// Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`

	// The customer-supplied name that uniquely identifies the DB instance when
	// interacting with the Amazon Timestream for InfluxDB API and CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Indicates if the DB instance has a public IP to facilitate access.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// The Availability Zone in which the standby instance is located when deploying
	// with a MultiAZ standby instance.
	SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"`

	// The status of the DB instance.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// A list of VPC security group IDs associated with the DB instance.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" min:"1" type:"list"`

	// A list of VPC subnet IDs associated with the DB instance.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `locationName:"vpcSubnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDbInstanceOutput) GoString

func (s DeleteDbInstanceOutput) 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 (*DeleteDbInstanceOutput) SetAllocatedStorage

func (s *DeleteDbInstanceOutput) SetAllocatedStorage(v int64) *DeleteDbInstanceOutput

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*DeleteDbInstanceOutput) SetArn

SetArn sets the Arn field's value.

func (*DeleteDbInstanceOutput) SetAvailabilityZone

func (s *DeleteDbInstanceOutput) SetAvailabilityZone(v string) *DeleteDbInstanceOutput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DeleteDbInstanceOutput) SetDbInstanceType

func (s *DeleteDbInstanceOutput) SetDbInstanceType(v string) *DeleteDbInstanceOutput

SetDbInstanceType sets the DbInstanceType field's value.

func (*DeleteDbInstanceOutput) SetDbParameterGroupIdentifier

func (s *DeleteDbInstanceOutput) SetDbParameterGroupIdentifier(v string) *DeleteDbInstanceOutput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*DeleteDbInstanceOutput) SetDbStorageType

func (s *DeleteDbInstanceOutput) SetDbStorageType(v string) *DeleteDbInstanceOutput

SetDbStorageType sets the DbStorageType field's value.

func (*DeleteDbInstanceOutput) SetDeploymentType

func (s *DeleteDbInstanceOutput) SetDeploymentType(v string) *DeleteDbInstanceOutput

SetDeploymentType sets the DeploymentType field's value.

func (*DeleteDbInstanceOutput) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*DeleteDbInstanceOutput) SetId

SetId sets the Id field's value.

func (*DeleteDbInstanceOutput) SetInfluxAuthParametersSecretArn

func (s *DeleteDbInstanceOutput) SetInfluxAuthParametersSecretArn(v string) *DeleteDbInstanceOutput

SetInfluxAuthParametersSecretArn sets the InfluxAuthParametersSecretArn field's value.

func (*DeleteDbInstanceOutput) SetLogDeliveryConfiguration

func (s *DeleteDbInstanceOutput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *DeleteDbInstanceOutput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (*DeleteDbInstanceOutput) SetName

SetName sets the Name field's value.

func (*DeleteDbInstanceOutput) SetPubliclyAccessible

func (s *DeleteDbInstanceOutput) SetPubliclyAccessible(v bool) *DeleteDbInstanceOutput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DeleteDbInstanceOutput) SetSecondaryAvailabilityZone

func (s *DeleteDbInstanceOutput) SetSecondaryAvailabilityZone(v string) *DeleteDbInstanceOutput

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*DeleteDbInstanceOutput) SetStatus

SetStatus sets the Status field's value.

func (*DeleteDbInstanceOutput) SetVpcSecurityGroupIds

func (s *DeleteDbInstanceOutput) SetVpcSecurityGroupIds(v []*string) *DeleteDbInstanceOutput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*DeleteDbInstanceOutput) SetVpcSubnetIds

func (s *DeleteDbInstanceOutput) SetVpcSubnetIds(v []*string) *DeleteDbInstanceOutput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (DeleteDbInstanceOutput) String

func (s DeleteDbInstanceOutput) 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 GetDbInstanceInput

type GetDbInstanceInput struct {

	// The id of the DB instance.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDbInstanceInput) GoString

func (s GetDbInstanceInput) 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 (*GetDbInstanceInput) SetIdentifier

func (s *GetDbInstanceInput) SetIdentifier(v string) *GetDbInstanceInput

SetIdentifier sets the Identifier field's value.

func (GetDbInstanceInput) String

func (s GetDbInstanceInput) 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 (*GetDbInstanceInput) Validate

func (s *GetDbInstanceInput) Validate() error

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

type GetDbInstanceOutput

type GetDbInstanceOutput struct {

	// The amount of storage allocated for your DB storage type (in gibibytes).
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The Availability Zone in which the DB instance resides.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The Timestream for InfluxDB instance type that InfluxDB runs on.
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" enum:"DbInstanceType"`

	// The id of the DB parameter group assigned to your DB instance.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or
	// with a MultiAZ Standby for High availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing
	// the initial InfluxDB authorization parameters. The secret value is a JSON
	// formatted key-value pair holding InfluxDB authorization values: organization,
	// bucket, username, and password.
	InfluxAuthParametersSecretArn *string `locationName:"influxAuthParametersSecretArn" type:"string"`

	// Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`

	// The customer-supplied name that uniquely identifies the DB instance when
	// interacting with the Amazon Timestream for InfluxDB API and CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Indicates if the DB instance has a public IP to facilitate access.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// The Availability Zone in which the standby instance is located when deploying
	// with a MultiAZ standby instance.
	SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"`

	// The status of the DB instance.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// A list of VPC security group IDs associated with the DB instance.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" min:"1" type:"list"`

	// A list of VPC subnet IDs associated with the DB instance.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `locationName:"vpcSubnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetDbInstanceOutput) GoString

func (s GetDbInstanceOutput) 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 (*GetDbInstanceOutput) SetAllocatedStorage

func (s *GetDbInstanceOutput) SetAllocatedStorage(v int64) *GetDbInstanceOutput

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*GetDbInstanceOutput) SetArn

SetArn sets the Arn field's value.

func (*GetDbInstanceOutput) SetAvailabilityZone

func (s *GetDbInstanceOutput) SetAvailabilityZone(v string) *GetDbInstanceOutput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*GetDbInstanceOutput) SetDbInstanceType

func (s *GetDbInstanceOutput) SetDbInstanceType(v string) *GetDbInstanceOutput

SetDbInstanceType sets the DbInstanceType field's value.

func (*GetDbInstanceOutput) SetDbParameterGroupIdentifier

func (s *GetDbInstanceOutput) SetDbParameterGroupIdentifier(v string) *GetDbInstanceOutput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*GetDbInstanceOutput) SetDbStorageType

func (s *GetDbInstanceOutput) SetDbStorageType(v string) *GetDbInstanceOutput

SetDbStorageType sets the DbStorageType field's value.

func (*GetDbInstanceOutput) SetDeploymentType

func (s *GetDbInstanceOutput) SetDeploymentType(v string) *GetDbInstanceOutput

SetDeploymentType sets the DeploymentType field's value.

func (*GetDbInstanceOutput) SetEndpoint

func (s *GetDbInstanceOutput) SetEndpoint(v string) *GetDbInstanceOutput

SetEndpoint sets the Endpoint field's value.

func (*GetDbInstanceOutput) SetId

SetId sets the Id field's value.

func (*GetDbInstanceOutput) SetInfluxAuthParametersSecretArn

func (s *GetDbInstanceOutput) SetInfluxAuthParametersSecretArn(v string) *GetDbInstanceOutput

SetInfluxAuthParametersSecretArn sets the InfluxAuthParametersSecretArn field's value.

func (*GetDbInstanceOutput) SetLogDeliveryConfiguration

func (s *GetDbInstanceOutput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *GetDbInstanceOutput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (*GetDbInstanceOutput) SetName

SetName sets the Name field's value.

func (*GetDbInstanceOutput) SetPubliclyAccessible

func (s *GetDbInstanceOutput) SetPubliclyAccessible(v bool) *GetDbInstanceOutput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*GetDbInstanceOutput) SetSecondaryAvailabilityZone

func (s *GetDbInstanceOutput) SetSecondaryAvailabilityZone(v string) *GetDbInstanceOutput

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*GetDbInstanceOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetDbInstanceOutput) SetVpcSecurityGroupIds

func (s *GetDbInstanceOutput) SetVpcSecurityGroupIds(v []*string) *GetDbInstanceOutput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*GetDbInstanceOutput) SetVpcSubnetIds

func (s *GetDbInstanceOutput) SetVpcSubnetIds(v []*string) *GetDbInstanceOutput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (GetDbInstanceOutput) String

func (s GetDbInstanceOutput) 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 GetDbParameterGroupInput

type GetDbParameterGroupInput struct {

	// The id of the DB parameter group.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDbParameterGroupInput) GoString

func (s GetDbParameterGroupInput) 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 (*GetDbParameterGroupInput) SetIdentifier

SetIdentifier sets the Identifier field's value.

func (GetDbParameterGroupInput) String

func (s GetDbParameterGroupInput) 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 (*GetDbParameterGroupInput) Validate

func (s *GetDbParameterGroupInput) Validate() error

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

type GetDbParameterGroupOutput

type GetDbParameterGroupOutput struct {

	// The Amazon Resource Name (ARN) of the DB parameter group.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// A description of the DB parameter group.
	Description *string `locationName:"description" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The customer-supplied name that uniquely identifies the DB parameter group
	// when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// The parameters that comprise the DB parameter group.
	Parameters *Parameters `locationName:"parameters" type:"structure"`
	// contains filtered or unexported fields
}

func (GetDbParameterGroupOutput) GoString

func (s GetDbParameterGroupOutput) 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 (*GetDbParameterGroupOutput) SetArn

SetArn sets the Arn field's value.

func (*GetDbParameterGroupOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetDbParameterGroupOutput) SetId

SetId sets the Id field's value.

func (*GetDbParameterGroupOutput) SetName

SetName sets the Name field's value.

func (*GetDbParameterGroupOutput) SetParameters

SetParameters sets the Parameters field's value.

func (GetDbParameterGroupOutput) String

func (s GetDbParameterGroupOutput) 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 InfluxDBv2Parameters

type InfluxDBv2Parameters struct {

	// Include option to show detailed logs for Flux queries.
	//
	// Default: false
	FluxLogEnabled *bool `locationName:"fluxLogEnabled" type:"boolean"`

	// Log output level. InfluxDB outputs log entries with severity levels greater
	// than or equal to the level specified.
	//
	// Default: info
	LogLevel *string `locationName:"logLevel" type:"string" enum:"LogLevel"`

	// Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics
	// (https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/).
	//
	// Default: false
	MetricsDisabled *bool `locationName:"metricsDisabled" type:"boolean"`

	// Disable the task scheduler. If problematic tasks prevent InfluxDB from starting,
	// use this option to start InfluxDB without scheduling or executing tasks.
	//
	// Default: false
	NoTasks *bool `locationName:"noTasks" type:"boolean"`

	// Number of queries allowed to execute concurrently. Setting to 0 allows an
	// unlimited number of concurrent queries.
	//
	// Default: 0
	QueryConcurrency *int64 `locationName:"queryConcurrency" type:"integer"`

	// Maximum number of queries allowed in execution queue. When queue limit is
	// reached, new queries are rejected. Setting to 0 allows an unlimited number
	// of queries in the queue.
	//
	// Default: 0
	QueryQueueSize *int64 `locationName:"queryQueueSize" type:"integer"`

	// Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled
	// by default.
	TracingType *string `locationName:"tracingType" type:"string" enum:"TracingType"`
	// contains filtered or unexported fields
}

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

func (InfluxDBv2Parameters) GoString

func (s InfluxDBv2Parameters) 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 (*InfluxDBv2Parameters) SetFluxLogEnabled

func (s *InfluxDBv2Parameters) SetFluxLogEnabled(v bool) *InfluxDBv2Parameters

SetFluxLogEnabled sets the FluxLogEnabled field's value.

func (*InfluxDBv2Parameters) SetLogLevel

SetLogLevel sets the LogLevel field's value.

func (*InfluxDBv2Parameters) SetMetricsDisabled

func (s *InfluxDBv2Parameters) SetMetricsDisabled(v bool) *InfluxDBv2Parameters

SetMetricsDisabled sets the MetricsDisabled field's value.

func (*InfluxDBv2Parameters) SetNoTasks

SetNoTasks sets the NoTasks field's value.

func (*InfluxDBv2Parameters) SetQueryConcurrency

func (s *InfluxDBv2Parameters) SetQueryConcurrency(v int64) *InfluxDBv2Parameters

SetQueryConcurrency sets the QueryConcurrency field's value.

func (*InfluxDBv2Parameters) SetQueryQueueSize

func (s *InfluxDBv2Parameters) SetQueryQueueSize(v int64) *InfluxDBv2Parameters

SetQueryQueueSize sets the QueryQueueSize field's value.

func (*InfluxDBv2Parameters) SetTracingType

func (s *InfluxDBv2Parameters) SetTracingType(v string) *InfluxDBv2Parameters

SetTracingType sets the TracingType field's value.

func (InfluxDBv2Parameters) String

func (s InfluxDBv2Parameters) 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 InternalServerException

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

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

The request processing has failed because of an unknown error, exception or failure.

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 ListDbInstancesInput

type ListDbInstancesInput struct {

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

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDbInstancesInput) GoString

func (s ListDbInstancesInput) 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 (*ListDbInstancesInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListDbInstancesInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListDbInstancesInput) String

func (s ListDbInstancesInput) 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 (*ListDbInstancesInput) Validate

func (s *ListDbInstancesInput) Validate() error

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

type ListDbInstancesOutput

type ListDbInstancesOutput struct {

	// A list of Timestream for InfluxDB DB instance summaries.
	//
	// Items is a required field
	Items []*DbInstanceSummary `locationName:"items" type:"list" required:"true"`

	// Token from a previous call of the operation. When this value is provided,
	// the service returns results from where the previous response left off.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDbInstancesOutput) GoString

func (s ListDbInstancesOutput) 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 (*ListDbInstancesOutput) SetItems

SetItems sets the Items field's value.

func (*ListDbInstancesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDbInstancesOutput) String

func (s ListDbInstancesOutput) 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 ListDbParameterGroupsInput

type ListDbParameterGroupsInput struct {

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

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDbParameterGroupsInput) GoString

func (s ListDbParameterGroupsInput) 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 (*ListDbParameterGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDbParameterGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDbParameterGroupsInput) 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 (*ListDbParameterGroupsInput) Validate

func (s *ListDbParameterGroupsInput) Validate() error

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

type ListDbParameterGroupsOutput

type ListDbParameterGroupsOutput struct {

	// A list of Timestream for InfluxDB DB parameter group summaries.
	//
	// Items is a required field
	Items []*DbParameterGroupSummary `locationName:"items" type:"list" required:"true"`

	// Token from a previous call of the operation. When this value is provided,
	// the service returns results from where the previous response left off.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDbParameterGroupsOutput) GoString

func (s ListDbParameterGroupsOutput) 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 (*ListDbParameterGroupsOutput) SetItems

SetItems sets the Items field's value.

func (*ListDbParameterGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDbParameterGroupsOutput) 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 Amazon Resource Name (ARN) of the tagged resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" 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

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 {

	// A list of tags used to categorize and track resources.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// 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

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 LogDeliveryConfiguration

type LogDeliveryConfiguration struct {

	// Configuration for S3 bucket log delivery.
	//
	// S3Configuration is a required field
	S3Configuration *S3Configuration `locationName:"s3Configuration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

func (LogDeliveryConfiguration) GoString

func (s LogDeliveryConfiguration) 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 (*LogDeliveryConfiguration) SetS3Configuration

SetS3Configuration sets the S3Configuration field's value.

func (LogDeliveryConfiguration) String

func (s LogDeliveryConfiguration) 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 (*LogDeliveryConfiguration) Validate

func (s *LogDeliveryConfiguration) Validate() error

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

type Parameters

type Parameters struct {

	// All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
	InfluxDBv2 *InfluxDBv2Parameters `type:"structure"`
	// contains filtered or unexported fields
}

The parameters that comprise the parameter group.

func (Parameters) GoString

func (s Parameters) 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 (*Parameters) SetInfluxDBv2

func (s *Parameters) SetInfluxDBv2(v *InfluxDBv2Parameters) *Parameters

SetInfluxDBv2 sets the InfluxDBv2 field's value.

func (Parameters) String

func (s Parameters) 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"`

	// The identifier for the Timestream for InfluxDB resource associated with the
	// request.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of Timestream for InfluxDB resource associated with the request.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The requested resource was not found or does not exist.

func (*ResourceNotFoundException) Code

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 S3Configuration

type S3Configuration struct {

	// The name of the S3 bucket to deliver logs to.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`

	// Indicates whether log delivery to the S3 bucket is enabled.
	//
	// Enabled is a required field
	Enabled *bool `locationName:"enabled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Configuration for S3 bucket log delivery.

func (S3Configuration) GoString

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

func (s *S3Configuration) SetBucketName(v string) *S3Configuration

SetBucketName sets the BucketName field's value.

func (*S3Configuration) SetEnabled

func (s *S3Configuration) SetEnabled(v bool) *S3Configuration

SetEnabled sets the Enabled field's value.

func (S3Configuration) String

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

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
}

The request exceeds the service quota.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message

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

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 TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the tagged resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of tags used to categorize and track resources.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" 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 map[string]*string) *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"`

	// The number of seconds the caller should wait before retrying.
	RetryAfterSeconds *int64 `locationName:"retryAfterSeconds" type:"integer"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

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 TimestreamInfluxDB

type TimestreamInfluxDB struct {
	*client.Client
}

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

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

func New

New creates a new instance of the TimestreamInfluxDB 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 TimestreamInfluxDB client from just a session.
svc := timestreaminfluxdb.New(mySession)

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

func (*TimestreamInfluxDB) CreateDbInstance

func (c *TimestreamInfluxDB) CreateDbInstance(input *CreateDbInstanceInput) (*CreateDbInstanceOutput, error)

CreateDbInstance API operation for Timestream InfluxDB.

Creates a new Timestream for InfluxDB DB instance.

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 Timestream InfluxDB's API operation CreateDbInstance for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeds the service quota.

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstance

func (*TimestreamInfluxDB) CreateDbInstanceRequest

func (c *TimestreamInfluxDB) CreateDbInstanceRequest(input *CreateDbInstanceInput) (req *request.Request, output *CreateDbInstanceOutput)

CreateDbInstanceRequest generates a "aws/request.Request" representing the client's request for the CreateDbInstance 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 CreateDbInstance for more information on using the CreateDbInstance 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 CreateDbInstanceRequest method.
req, resp := client.CreateDbInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstance

func (*TimestreamInfluxDB) CreateDbInstanceWithContext

func (c *TimestreamInfluxDB) CreateDbInstanceWithContext(ctx aws.Context, input *CreateDbInstanceInput, opts ...request.Option) (*CreateDbInstanceOutput, error)

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

See CreateDbInstance 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 (*TimestreamInfluxDB) CreateDbParameterGroup

CreateDbParameterGroup API operation for Timestream InfluxDB.

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

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 Timestream InfluxDB's API operation CreateDbParameterGroup for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeds the service quota.

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbParameterGroup

func (*TimestreamInfluxDB) CreateDbParameterGroupRequest

func (c *TimestreamInfluxDB) CreateDbParameterGroupRequest(input *CreateDbParameterGroupInput) (req *request.Request, output *CreateDbParameterGroupOutput)

CreateDbParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDbParameterGroup 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 CreateDbParameterGroup for more information on using the CreateDbParameterGroup 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 CreateDbParameterGroupRequest method.
req, resp := client.CreateDbParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbParameterGroup

func (*TimestreamInfluxDB) CreateDbParameterGroupWithContext

func (c *TimestreamInfluxDB) CreateDbParameterGroupWithContext(ctx aws.Context, input *CreateDbParameterGroupInput, opts ...request.Option) (*CreateDbParameterGroupOutput, error)

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

See CreateDbParameterGroup 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 (*TimestreamInfluxDB) DeleteDbInstance

func (c *TimestreamInfluxDB) DeleteDbInstance(input *DeleteDbInstanceInput) (*DeleteDbInstanceOutput, error)

DeleteDbInstance API operation for Timestream InfluxDB.

Deletes a Timestream for InfluxDB DB instance.

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 Timestream InfluxDB's API operation DeleteDbInstance for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstance

func (*TimestreamInfluxDB) DeleteDbInstanceRequest

func (c *TimestreamInfluxDB) DeleteDbInstanceRequest(input *DeleteDbInstanceInput) (req *request.Request, output *DeleteDbInstanceOutput)

DeleteDbInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteDbInstance 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 DeleteDbInstance for more information on using the DeleteDbInstance 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 DeleteDbInstanceRequest method.
req, resp := client.DeleteDbInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstance

func (*TimestreamInfluxDB) DeleteDbInstanceWithContext

func (c *TimestreamInfluxDB) DeleteDbInstanceWithContext(ctx aws.Context, input *DeleteDbInstanceInput, opts ...request.Option) (*DeleteDbInstanceOutput, error)

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

See DeleteDbInstance 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 (*TimestreamInfluxDB) GetDbInstance

func (c *TimestreamInfluxDB) GetDbInstance(input *GetDbInstanceInput) (*GetDbInstanceOutput, error)

GetDbInstance API operation for Timestream InfluxDB.

Returns a Timestream for InfluxDB DB instance.

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 Timestream InfluxDB's API operation GetDbInstance for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstance

func (*TimestreamInfluxDB) GetDbInstanceRequest

func (c *TimestreamInfluxDB) GetDbInstanceRequest(input *GetDbInstanceInput) (req *request.Request, output *GetDbInstanceOutput)

GetDbInstanceRequest generates a "aws/request.Request" representing the client's request for the GetDbInstance 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 GetDbInstance for more information on using the GetDbInstance 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 GetDbInstanceRequest method.
req, resp := client.GetDbInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstance

func (*TimestreamInfluxDB) GetDbInstanceWithContext

func (c *TimestreamInfluxDB) GetDbInstanceWithContext(ctx aws.Context, input *GetDbInstanceInput, opts ...request.Option) (*GetDbInstanceOutput, error)

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

See GetDbInstance 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 (*TimestreamInfluxDB) GetDbParameterGroup

GetDbParameterGroup API operation for Timestream InfluxDB.

Returns a Timestream for InfluxDB DB parameter group.

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 Timestream InfluxDB's API operation GetDbParameterGroup for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbParameterGroup

func (*TimestreamInfluxDB) GetDbParameterGroupRequest

func (c *TimestreamInfluxDB) GetDbParameterGroupRequest(input *GetDbParameterGroupInput) (req *request.Request, output *GetDbParameterGroupOutput)

GetDbParameterGroupRequest generates a "aws/request.Request" representing the client's request for the GetDbParameterGroup 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 GetDbParameterGroup for more information on using the GetDbParameterGroup 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 GetDbParameterGroupRequest method.
req, resp := client.GetDbParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbParameterGroup

func (*TimestreamInfluxDB) GetDbParameterGroupWithContext

func (c *TimestreamInfluxDB) GetDbParameterGroupWithContext(ctx aws.Context, input *GetDbParameterGroupInput, opts ...request.Option) (*GetDbParameterGroupOutput, error)

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

See GetDbParameterGroup 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 (*TimestreamInfluxDB) ListDbInstances

func (c *TimestreamInfluxDB) ListDbInstances(input *ListDbInstancesInput) (*ListDbInstancesOutput, error)

ListDbInstances API operation for Timestream InfluxDB.

Returns a list of Timestream for InfluxDB DB instances.

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 Timestream InfluxDB's API operation ListDbInstances for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstances

func (*TimestreamInfluxDB) ListDbInstancesPages

func (c *TimestreamInfluxDB) ListDbInstancesPages(input *ListDbInstancesInput, fn func(*ListDbInstancesOutput, bool) bool) error

ListDbInstancesPages iterates over the pages of a ListDbInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDbInstances 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 ListDbInstances operation.
pageNum := 0
err := client.ListDbInstancesPages(params,
    func(page *timestreaminfluxdb.ListDbInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamInfluxDB) ListDbInstancesPagesWithContext

func (c *TimestreamInfluxDB) ListDbInstancesPagesWithContext(ctx aws.Context, input *ListDbInstancesInput, fn func(*ListDbInstancesOutput, bool) bool, opts ...request.Option) error

ListDbInstancesPagesWithContext same as ListDbInstancesPages 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 (*TimestreamInfluxDB) ListDbInstancesRequest

func (c *TimestreamInfluxDB) ListDbInstancesRequest(input *ListDbInstancesInput) (req *request.Request, output *ListDbInstancesOutput)

ListDbInstancesRequest generates a "aws/request.Request" representing the client's request for the ListDbInstances 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 ListDbInstances for more information on using the ListDbInstances 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 ListDbInstancesRequest method.
req, resp := client.ListDbInstancesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstances

func (*TimestreamInfluxDB) ListDbInstancesWithContext

func (c *TimestreamInfluxDB) ListDbInstancesWithContext(ctx aws.Context, input *ListDbInstancesInput, opts ...request.Option) (*ListDbInstancesOutput, error)

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

See ListDbInstances 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 (*TimestreamInfluxDB) ListDbParameterGroups

ListDbParameterGroups API operation for Timestream InfluxDB.

Returns a list of Timestream for InfluxDB DB parameter groups.

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 Timestream InfluxDB's API operation ListDbParameterGroups for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbParameterGroups

func (*TimestreamInfluxDB) ListDbParameterGroupsPages

func (c *TimestreamInfluxDB) ListDbParameterGroupsPages(input *ListDbParameterGroupsInput, fn func(*ListDbParameterGroupsOutput, bool) bool) error

ListDbParameterGroupsPages iterates over the pages of a ListDbParameterGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDbParameterGroups 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 ListDbParameterGroups operation.
pageNum := 0
err := client.ListDbParameterGroupsPages(params,
    func(page *timestreaminfluxdb.ListDbParameterGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TimestreamInfluxDB) ListDbParameterGroupsPagesWithContext

func (c *TimestreamInfluxDB) ListDbParameterGroupsPagesWithContext(ctx aws.Context, input *ListDbParameterGroupsInput, fn func(*ListDbParameterGroupsOutput, bool) bool, opts ...request.Option) error

ListDbParameterGroupsPagesWithContext same as ListDbParameterGroupsPages 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 (*TimestreamInfluxDB) ListDbParameterGroupsRequest

func (c *TimestreamInfluxDB) ListDbParameterGroupsRequest(input *ListDbParameterGroupsInput) (req *request.Request, output *ListDbParameterGroupsOutput)

ListDbParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the ListDbParameterGroups 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 ListDbParameterGroups for more information on using the ListDbParameterGroups 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 ListDbParameterGroupsRequest method.
req, resp := client.ListDbParameterGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbParameterGroups

func (*TimestreamInfluxDB) ListDbParameterGroupsWithContext

func (c *TimestreamInfluxDB) ListDbParameterGroupsWithContext(ctx aws.Context, input *ListDbParameterGroupsInput, opts ...request.Option) (*ListDbParameterGroupsOutput, error)

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

See ListDbParameterGroups 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 (*TimestreamInfluxDB) ListTagsForResource

ListTagsForResource API operation for Timestream InfluxDB.

A list of tags applied to the 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 Timestream InfluxDB's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource was not found or does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListTagsForResource

func (*TimestreamInfluxDB) ListTagsForResourceRequest

func (c *TimestreamInfluxDB) 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-influxdb-2023-01-27/ListTagsForResource

func (*TimestreamInfluxDB) ListTagsForResourceWithContext

func (c *TimestreamInfluxDB) 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 (*TimestreamInfluxDB) TagResource

func (c *TimestreamInfluxDB) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Timestream InfluxDB.

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

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 Timestream InfluxDB's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource was not found or does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/TagResource

func (*TimestreamInfluxDB) TagResourceRequest

func (c *TimestreamInfluxDB) 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-influxdb-2023-01-27/TagResource

func (*TimestreamInfluxDB) TagResourceWithContext

func (c *TimestreamInfluxDB) 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 (*TimestreamInfluxDB) UntagResource

func (c *TimestreamInfluxDB) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Timestream InfluxDB.

Removes the tag from the specified 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 Timestream InfluxDB's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource was not found or does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UntagResource

func (*TimestreamInfluxDB) UntagResourceRequest

func (c *TimestreamInfluxDB) 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-influxdb-2023-01-27/UntagResource

func (*TimestreamInfluxDB) UntagResourceWithContext

func (c *TimestreamInfluxDB) 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 (*TimestreamInfluxDB) UpdateDbInstance

func (c *TimestreamInfluxDB) UpdateDbInstance(input *UpdateDbInstanceInput) (*UpdateDbInstanceOutput, error)

UpdateDbInstance API operation for Timestream InfluxDB.

Updates a Timestream for InfluxDB DB instance.

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 Timestream InfluxDB's API operation UpdateDbInstance for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException The request processing has failed because of an unknown error, exception or failure.

  • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.

  • ResourceNotFoundException The requested resource was not found or does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstance

func (*TimestreamInfluxDB) UpdateDbInstanceRequest

func (c *TimestreamInfluxDB) UpdateDbInstanceRequest(input *UpdateDbInstanceInput) (req *request.Request, output *UpdateDbInstanceOutput)

UpdateDbInstanceRequest generates a "aws/request.Request" representing the client's request for the UpdateDbInstance 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 UpdateDbInstance for more information on using the UpdateDbInstance 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 UpdateDbInstanceRequest method.
req, resp := client.UpdateDbInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstance

func (*TimestreamInfluxDB) UpdateDbInstanceWithContext

func (c *TimestreamInfluxDB) UpdateDbInstanceWithContext(ctx aws.Context, input *UpdateDbInstanceInput, opts ...request.Option) (*UpdateDbInstanceOutput, error)

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

See UpdateDbInstance 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 Amazon Resource Name (ARN) of the tagged resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The keys used to identify the tags.
	//
	// TagKeys is a required field
	TagKeys []*string `locationName:"tagKeys" min:"1" 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 UpdateDbInstanceInput

type UpdateDbInstanceInput struct {

	// The id of the DB parameter group to assign to your DB instance. DB parameter
	// groups specify how the database is configured. For example, DB parameter
	// groups can specify the limit for query concurrency.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The id of the DB instance.
	//
	// Identifier is a required field
	Identifier *string `locationName:"identifier" min:"3" type:"string" required:"true"`

	// Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDbInstanceInput) GoString

func (s UpdateDbInstanceInput) 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 (*UpdateDbInstanceInput) SetDbParameterGroupIdentifier

func (s *UpdateDbInstanceInput) SetDbParameterGroupIdentifier(v string) *UpdateDbInstanceInput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*UpdateDbInstanceInput) SetIdentifier

func (s *UpdateDbInstanceInput) SetIdentifier(v string) *UpdateDbInstanceInput

SetIdentifier sets the Identifier field's value.

func (*UpdateDbInstanceInput) SetLogDeliveryConfiguration

func (s *UpdateDbInstanceInput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *UpdateDbInstanceInput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (UpdateDbInstanceInput) String

func (s UpdateDbInstanceInput) 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 (*UpdateDbInstanceInput) Validate

func (s *UpdateDbInstanceInput) Validate() error

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

type UpdateDbInstanceOutput

type UpdateDbInstanceOutput struct {

	// The amount of storage allocated for your DB storage type (in gibibytes).
	AllocatedStorage *int64 `locationName:"allocatedStorage" min:"20" type:"integer"`

	// The Amazon Resource Name (ARN) of the DB instance.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The Availability Zone in which the DB instance resides.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The Timestream for InfluxDB instance type that InfluxDB runs on.
	DbInstanceType *string `locationName:"dbInstanceType" type:"string" enum:"DbInstanceType"`

	// The id of the DB parameter group assigned to your DB instance.
	DbParameterGroupIdentifier *string `locationName:"dbParameterGroupIdentifier" min:"3" type:"string"`

	// The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
	DbStorageType *string `locationName:"dbStorageType" type:"string" enum:"DbStorageType"`

	// Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or
	// with a MultiAZ Standby for High availability.
	DeploymentType *string `locationName:"deploymentType" type:"string" enum:"DeploymentType"`

	// The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
	Endpoint *string `locationName:"endpoint" type:"string"`

	// A service-generated unique identifier.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"3" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing
	// the initial InfluxDB authorization parameters. The secret value is a JSON
	// formatted key-value pair holding InfluxDB authorization values: organization,
	// bucket, username, and password.
	InfluxAuthParametersSecretArn *string `locationName:"influxAuthParametersSecretArn" type:"string"`

	// Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
	LogDeliveryConfiguration *LogDeliveryConfiguration `locationName:"logDeliveryConfiguration" type:"structure"`

	// This customer-supplied name uniquely identifies the DB instance when interacting
	// with the Amazon Timestream for InfluxDB API and AWS CLI commands.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"3" type:"string" required:"true"`

	// Indicates if the DB instance has a public IP to facilitate access.
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	// The Availability Zone in which the standby instance is located when deploying
	// with a MultiAZ standby instance.
	SecondaryAvailabilityZone *string `locationName:"secondaryAvailabilityZone" type:"string"`

	// The status of the DB instance.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// A list of VPC security group IDs associated with the DB instance.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" min:"1" type:"list"`

	// A list of VPC subnet IDs associated with the DB instance.
	//
	// VpcSubnetIds is a required field
	VpcSubnetIds []*string `locationName:"vpcSubnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDbInstanceOutput) GoString

func (s UpdateDbInstanceOutput) 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 (*UpdateDbInstanceOutput) SetAllocatedStorage

func (s *UpdateDbInstanceOutput) SetAllocatedStorage(v int64) *UpdateDbInstanceOutput

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*UpdateDbInstanceOutput) SetArn

SetArn sets the Arn field's value.

func (*UpdateDbInstanceOutput) SetAvailabilityZone

func (s *UpdateDbInstanceOutput) SetAvailabilityZone(v string) *UpdateDbInstanceOutput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*UpdateDbInstanceOutput) SetDbInstanceType

func (s *UpdateDbInstanceOutput) SetDbInstanceType(v string) *UpdateDbInstanceOutput

SetDbInstanceType sets the DbInstanceType field's value.

func (*UpdateDbInstanceOutput) SetDbParameterGroupIdentifier

func (s *UpdateDbInstanceOutput) SetDbParameterGroupIdentifier(v string) *UpdateDbInstanceOutput

SetDbParameterGroupIdentifier sets the DbParameterGroupIdentifier field's value.

func (*UpdateDbInstanceOutput) SetDbStorageType

func (s *UpdateDbInstanceOutput) SetDbStorageType(v string) *UpdateDbInstanceOutput

SetDbStorageType sets the DbStorageType field's value.

func (*UpdateDbInstanceOutput) SetDeploymentType

func (s *UpdateDbInstanceOutput) SetDeploymentType(v string) *UpdateDbInstanceOutput

SetDeploymentType sets the DeploymentType field's value.

func (*UpdateDbInstanceOutput) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*UpdateDbInstanceOutput) SetId

SetId sets the Id field's value.

func (*UpdateDbInstanceOutput) SetInfluxAuthParametersSecretArn

func (s *UpdateDbInstanceOutput) SetInfluxAuthParametersSecretArn(v string) *UpdateDbInstanceOutput

SetInfluxAuthParametersSecretArn sets the InfluxAuthParametersSecretArn field's value.

func (*UpdateDbInstanceOutput) SetLogDeliveryConfiguration

func (s *UpdateDbInstanceOutput) SetLogDeliveryConfiguration(v *LogDeliveryConfiguration) *UpdateDbInstanceOutput

SetLogDeliveryConfiguration sets the LogDeliveryConfiguration field's value.

func (*UpdateDbInstanceOutput) SetName

SetName sets the Name field's value.

func (*UpdateDbInstanceOutput) SetPubliclyAccessible

func (s *UpdateDbInstanceOutput) SetPubliclyAccessible(v bool) *UpdateDbInstanceOutput

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*UpdateDbInstanceOutput) SetSecondaryAvailabilityZone

func (s *UpdateDbInstanceOutput) SetSecondaryAvailabilityZone(v string) *UpdateDbInstanceOutput

SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.

func (*UpdateDbInstanceOutput) SetStatus

SetStatus sets the Status field's value.

func (*UpdateDbInstanceOutput) SetVpcSecurityGroupIds

func (s *UpdateDbInstanceOutput) SetVpcSecurityGroupIds(v []*string) *UpdateDbInstanceOutput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (*UpdateDbInstanceOutput) SetVpcSubnetIds

func (s *UpdateDbInstanceOutput) SetVpcSubnetIds(v []*string) *UpdateDbInstanceOutput

SetVpcSubnetIds sets the VpcSubnetIds field's value.

func (UpdateDbInstanceOutput) String

func (s UpdateDbInstanceOutput) 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"`

	// The reason that validation failed.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

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

Directories

Path Synopsis
Package timestreaminfluxdbiface provides an interface to enable mocking the Timestream InfluxDB service client for testing your code.
Package timestreaminfluxdbiface provides an interface to enable mocking the Timestream InfluxDB service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL