redshiftserverless

package module
v1.17.1 Latest Latest
Warning

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

Go to latest
Published: Feb 23, 2024 License: Apache-2.0 Imports: 40 Imported by: 13

Documentation

Overview

Package redshiftserverless provides the API client, operations, and parameter types for Redshift Serverless.

This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless. Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers. To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-whatis.html) .

Index

Constants

View Source
const ServiceAPIVersion = "2021-04-21"
View Source
const ServiceID = "Redshift Serverless"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.5.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.12.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.12.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.12.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.12.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Redshift Serverless.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) ConvertRecoveryPointToSnapshot

func (c *Client) ConvertRecoveryPointToSnapshot(ctx context.Context, params *ConvertRecoveryPointToSnapshotInput, optFns ...func(*Options)) (*ConvertRecoveryPointToSnapshotOutput, error)

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html) .

func (*Client) CreateCustomDomainAssociation added in v1.9.0

func (c *Client) CreateCustomDomainAssociation(ctx context.Context, params *CreateCustomDomainAssociationInput, optFns ...func(*Options)) (*CreateCustomDomainAssociationOutput, error)

Creates a custom domain association for Amazon Redshift Serverless.

func (*Client) CreateEndpointAccess

func (c *Client) CreateEndpointAccess(ctx context.Context, params *CreateEndpointAccessInput, optFns ...func(*Options)) (*CreateEndpointAccessOutput, error)

Creates an Amazon Redshift Serverless managed VPC endpoint.

func (*Client) CreateNamespace

func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)

Creates a namespace in Amazon Redshift Serverless.

func (*Client) CreateScheduledAction added in v1.15.0

func (c *Client) CreateScheduledAction(ctx context.Context, params *CreateScheduledActionInput, optFns ...func(*Options)) (*CreateScheduledActionOutput, error)

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points (https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-snapshots-recovery.html) .

func (*Client) CreateSnapshotCopyConfiguration added in v1.15.0

func (c *Client) CreateSnapshotCopyConfiguration(ctx context.Context, params *CreateSnapshotCopyConfigurationInput, optFns ...func(*Options)) (*CreateSnapshotCopyConfigurationOutput, error)

Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.

func (*Client) CreateUsageLimit

func (c *Client) CreateUsageLimit(ctx context.Context, params *CreateUsageLimitInput, optFns ...func(*Options)) (*CreateUsageLimitOutput, error)

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

func (*Client) CreateWorkgroup

func (c *Client) CreateWorkgroup(ctx context.Context, params *CreateWorkgroupInput, optFns ...func(*Options)) (*CreateWorkgroupOutput, error)

Creates an workgroup in Amazon Redshift Serverless.

func (*Client) DeleteCustomDomainAssociation added in v1.9.0

func (c *Client) DeleteCustomDomainAssociation(ctx context.Context, params *DeleteCustomDomainAssociationInput, optFns ...func(*Options)) (*DeleteCustomDomainAssociationOutput, error)

Deletes a custom domain association for Amazon Redshift Serverless.

func (*Client) DeleteEndpointAccess

func (c *Client) DeleteEndpointAccess(ctx context.Context, params *DeleteEndpointAccessInput, optFns ...func(*Options)) (*DeleteEndpointAccessOutput, error)

Deletes an Amazon Redshift Serverless managed VPC endpoint.

func (*Client) DeleteNamespace

func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)

Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

func (*Client) DeleteResourcePolicy

func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)

Deletes the specified resource policy.

func (*Client) DeleteScheduledAction added in v1.15.0

func (c *Client) DeleteScheduledAction(ctx context.Context, params *DeleteScheduledActionInput, optFns ...func(*Options)) (*DeleteScheduledActionOutput, error)

Deletes a scheduled action.

func (*Client) DeleteSnapshot

func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error)

Deletes a snapshot from Amazon Redshift Serverless.

func (*Client) DeleteSnapshotCopyConfiguration added in v1.15.0

func (c *Client) DeleteSnapshotCopyConfiguration(ctx context.Context, params *DeleteSnapshotCopyConfigurationInput, optFns ...func(*Options)) (*DeleteSnapshotCopyConfigurationOutput, error)

Deletes a snapshot copy configuration

func (*Client) DeleteUsageLimit

func (c *Client) DeleteUsageLimit(ctx context.Context, params *DeleteUsageLimitInput, optFns ...func(*Options)) (*DeleteUsageLimitOutput, error)

Deletes a usage limit from Amazon Redshift Serverless.

func (*Client) DeleteWorkgroup

func (c *Client) DeleteWorkgroup(ctx context.Context, params *DeleteWorkgroupInput, optFns ...func(*Options)) (*DeleteWorkgroupOutput, error)

Deletes a workgroup.

func (*Client) GetCredentials

func (c *Client) GetCredentials(ctx context.Context, params *GetCredentialsInput, optFns ...func(*Options)) (*GetCredentialsOutput, error)

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources. If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

func (*Client) GetCustomDomainAssociation added in v1.9.0

func (c *Client) GetCustomDomainAssociation(ctx context.Context, params *GetCustomDomainAssociationInput, optFns ...func(*Options)) (*GetCustomDomainAssociationOutput, error)

Gets information about a specific custom domain association.

func (*Client) GetEndpointAccess

func (c *Client) GetEndpointAccess(ctx context.Context, params *GetEndpointAccessInput, optFns ...func(*Options)) (*GetEndpointAccessOutput, error)

Returns information, such as the name, about a VPC endpoint.

func (*Client) GetNamespace

func (c *Client) GetNamespace(ctx context.Context, params *GetNamespaceInput, optFns ...func(*Options)) (*GetNamespaceOutput, error)

Returns information about a namespace in Amazon Redshift Serverless.

func (*Client) GetRecoveryPoint

func (c *Client) GetRecoveryPoint(ctx context.Context, params *GetRecoveryPointInput, optFns ...func(*Options)) (*GetRecoveryPointOutput, error)

Returns information about a recovery point.

func (*Client) GetResourcePolicy

func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error)

Returns a resource policy.

func (*Client) GetScheduledAction added in v1.15.0

func (c *Client) GetScheduledAction(ctx context.Context, params *GetScheduledActionInput, optFns ...func(*Options)) (*GetScheduledActionOutput, error)

Returns information about a scheduled action.

func (*Client) GetSnapshot

func (c *Client) GetSnapshot(ctx context.Context, params *GetSnapshotInput, optFns ...func(*Options)) (*GetSnapshotOutput, error)

Returns information about a specific snapshot.

func (*Client) GetTableRestoreStatus added in v1.3.0

func (c *Client) GetTableRestoreStatus(ctx context.Context, params *GetTableRestoreStatusInput, optFns ...func(*Options)) (*GetTableRestoreStatusOutput, error)

Returns information about a TableRestoreStatus object.

func (*Client) GetUsageLimit

func (c *Client) GetUsageLimit(ctx context.Context, params *GetUsageLimitInput, optFns ...func(*Options)) (*GetUsageLimitOutput, error)

Returns information about a usage limit.

func (*Client) GetWorkgroup

func (c *Client) GetWorkgroup(ctx context.Context, params *GetWorkgroupInput, optFns ...func(*Options)) (*GetWorkgroupOutput, error)

Returns information about a specific workgroup.

func (*Client) ListCustomDomainAssociations added in v1.9.0

func (c *Client) ListCustomDomainAssociations(ctx context.Context, params *ListCustomDomainAssociationsInput, optFns ...func(*Options)) (*ListCustomDomainAssociationsOutput, error)

Lists custom domain associations for Amazon Redshift Serverless.

func (*Client) ListEndpointAccess

func (c *Client) ListEndpointAccess(ctx context.Context, params *ListEndpointAccessInput, optFns ...func(*Options)) (*ListEndpointAccessOutput, error)

Returns an array of EndpointAccess objects and relevant information.

func (*Client) ListNamespaces

func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)

Returns information about a list of specified namespaces.

func (*Client) ListRecoveryPoints

func (c *Client) ListRecoveryPoints(ctx context.Context, params *ListRecoveryPointsInput, optFns ...func(*Options)) (*ListRecoveryPointsOutput, error)

Returns an array of recovery points.

func (*Client) ListScheduledActions added in v1.15.0

func (c *Client) ListScheduledActions(ctx context.Context, params *ListScheduledActionsInput, optFns ...func(*Options)) (*ListScheduledActionsOutput, error)

Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.

func (*Client) ListSnapshotCopyConfigurations added in v1.15.0

func (c *Client) ListSnapshotCopyConfigurations(ctx context.Context, params *ListSnapshotCopyConfigurationsInput, optFns ...func(*Options)) (*ListSnapshotCopyConfigurationsOutput, error)

Returns a list of snapshot copy configurations.

func (*Client) ListSnapshots

func (c *Client) ListSnapshots(ctx context.Context, params *ListSnapshotsInput, optFns ...func(*Options)) (*ListSnapshotsOutput, error)

Returns a list of snapshots.

func (*Client) ListTableRestoreStatus added in v1.3.0

func (c *Client) ListTableRestoreStatus(ctx context.Context, params *ListTableRestoreStatusInput, optFns ...func(*Options)) (*ListTableRestoreStatusOutput, error)

Returns information about an array of TableRestoreStatus objects.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags assigned to a resource.

func (*Client) ListUsageLimits

func (c *Client) ListUsageLimits(ctx context.Context, params *ListUsageLimitsInput, optFns ...func(*Options)) (*ListUsageLimitsOutput, error)

Lists all usage limits within Amazon Redshift Serverless.

func (*Client) ListWorkgroups

func (c *Client) ListWorkgroups(ctx context.Context, params *ListWorkgroupsInput, optFns ...func(*Options)) (*ListWorkgroupsOutput, error)

Returns information about a list of specified workgroups.

func (*Client) Options added in v1.14.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutResourcePolicy

func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

func (*Client) RestoreFromRecoveryPoint

func (c *Client) RestoreFromRecoveryPoint(ctx context.Context, params *RestoreFromRecoveryPointInput, optFns ...func(*Options)) (*RestoreFromRecoveryPointOutput, error)

Restore the data from a recovery point.

func (*Client) RestoreFromSnapshot

func (c *Client) RestoreFromSnapshot(ctx context.Context, params *RestoreFromSnapshotInput, optFns ...func(*Options)) (*RestoreFromSnapshotOutput, error)

Restores a namespace from a snapshot.

func (*Client) RestoreTableFromRecoveryPoint added in v1.15.0

func (c *Client) RestoreTableFromRecoveryPoint(ctx context.Context, params *RestoreTableFromRecoveryPointInput, optFns ...func(*Options)) (*RestoreTableFromRecoveryPointOutput, error)

Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.

func (*Client) RestoreTableFromSnapshot added in v1.3.0

func (c *Client) RestoreTableFromSnapshot(ctx context.Context, params *RestoreTableFromSnapshotInput, optFns ...func(*Options)) (*RestoreTableFromSnapshotOutput, error)

Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys (https://docs.aws.amazon.com/redshift/latest/dg/t_Sorting_data.html#t_Sorting_data-interleaved) .

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns one or more tags to a resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag or set of tags from a resource.

func (*Client) UpdateCustomDomainAssociation added in v1.9.0

func (c *Client) UpdateCustomDomainAssociation(ctx context.Context, params *UpdateCustomDomainAssociationInput, optFns ...func(*Options)) (*UpdateCustomDomainAssociationOutput, error)

Updates an Amazon Redshift Serverless certificate associated with a custom domain.

func (*Client) UpdateEndpointAccess

func (c *Client) UpdateEndpointAccess(ctx context.Context, params *UpdateEndpointAccessInput, optFns ...func(*Options)) (*UpdateEndpointAccessOutput, error)

Updates an Amazon Redshift Serverless managed endpoint.

func (*Client) UpdateNamespace

func (c *Client) UpdateNamespace(ctx context.Context, params *UpdateNamespaceInput, optFns ...func(*Options)) (*UpdateNamespaceOutput, error)

Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.

func (*Client) UpdateScheduledAction added in v1.15.0

func (c *Client) UpdateScheduledAction(ctx context.Context, params *UpdateScheduledActionInput, optFns ...func(*Options)) (*UpdateScheduledActionOutput, error)

Updates a scheduled action.

func (*Client) UpdateSnapshot

func (c *Client) UpdateSnapshot(ctx context.Context, params *UpdateSnapshotInput, optFns ...func(*Options)) (*UpdateSnapshotOutput, error)

Updates a snapshot.

func (*Client) UpdateSnapshotCopyConfiguration added in v1.15.0

func (c *Client) UpdateSnapshotCopyConfiguration(ctx context.Context, params *UpdateSnapshotCopyConfigurationInput, optFns ...func(*Options)) (*UpdateSnapshotCopyConfigurationOutput, error)

Updates a snapshot copy configuration.

func (*Client) UpdateUsageLimit

func (c *Client) UpdateUsageLimit(ctx context.Context, params *UpdateUsageLimitInput, optFns ...func(*Options)) (*UpdateUsageLimitOutput, error)

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

func (*Client) UpdateWorkgroup

func (c *Client) UpdateWorkgroup(ctx context.Context, params *UpdateWorkgroupInput, optFns ...func(*Options)) (*UpdateWorkgroupOutput, error)

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.

type ConvertRecoveryPointToSnapshotInput

type ConvertRecoveryPointToSnapshotInput struct {

	// The unique identifier of the recovery point.
	//
	// This member is required.
	RecoveryPointId *string

	// The name of the snapshot.
	//
	// This member is required.
	SnapshotName *string

	// How long to retain the snapshot.
	RetentionPeriod *int32

	// An array of Tag objects (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html)
	// to associate with the created snapshot.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type ConvertRecoveryPointToSnapshotOutput

type ConvertRecoveryPointToSnapshotOutput struct {

	// The snapshot converted from the recovery point.
	Snapshot *types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomDomainAssociationInput added in v1.9.0

type CreateCustomDomainAssociationInput struct {

	// The custom domain name’s certificate Amazon resource name (ARN).
	//
	// This member is required.
	CustomDomainCertificateArn *string

	// The custom domain name to associate with the workgroup.
	//
	// This member is required.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type CreateCustomDomainAssociationOutput added in v1.9.0

type CreateCustomDomainAssociationOutput struct {

	// The custom domain name’s certificate Amazon resource name (ARN).
	CustomDomainCertificateArn *string

	// The expiration time for the certificate.
	CustomDomainCertificateExpiryTime *time.Time

	// The custom domain name to associate with the workgroup.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	WorkgroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEndpointAccessInput

type CreateEndpointAccessInput struct {

	// The name of the VPC endpoint. An endpoint name must contain 1-30 characters.
	// Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a
	// letter. The name can't contain two consecutive hyphens or end with a hyphen.
	//
	// This member is required.
	EndpointName *string

	// The unique identifers of subnets from which Amazon Redshift Serverless chooses
	// one to deploy a VPC endpoint.
	//
	// This member is required.
	SubnetIds []string

	// The name of the workgroup to associate with the VPC endpoint.
	//
	// This member is required.
	WorkgroupName *string

	// The owner Amazon Web Services account for the Amazon Redshift Serverless
	// workgroup.
	OwnerAccount *string

	// The unique identifiers of the security group that defines the ports, protocols,
	// and sources for inbound traffic that you are authorizing into your endpoint.
	VpcSecurityGroupIds []string
	// contains filtered or unexported fields
}

type CreateEndpointAccessOutput

type CreateEndpointAccessOutput struct {

	// The created VPC endpoint.
	Endpoint *types.EndpointAccess

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateNamespaceInput

type CreateNamespaceInput struct {

	// The name of the namespace.
	//
	// This member is required.
	NamespaceName *string

	// The ID of the Key Management Service (KMS) key used to encrypt and store the
	// namespace's admin credentials secret. You can only use this parameter if
	// manageAdminPassword is true.
	AdminPasswordSecretKmsKeyId *string

	// The password of the administrator for the first database created in the
	// namespace. You can't use adminUserPassword if manageAdminPassword is true.
	AdminUserPassword *string

	// The username of the administrator for the first database created in the
	// namespace.
	AdminUsername *string

	// The name of the first database created in the namespace.
	DbName *string

	// The Amazon Resource Name (ARN) of the IAM role to set as a default in the
	// namespace.
	DefaultIamRoleArn *string

	// A list of IAM roles to associate with the namespace.
	IamRoles []string

	// The ID of the Amazon Web Services Key Management Service key used to encrypt
	// your data.
	KmsKeyId *string

	// The types of logs the namespace can export. Available export types are userlog ,
	// connectionlog , and useractivitylog .
	LogExports []types.LogExport

	// If true , Amazon Redshift uses Secrets Manager to manage the namespace's admin
	// credentials. You can't use adminUserPassword if manageAdminPassword is true. If
	// manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword
	// for the admin user account's password.
	ManageAdminPassword *bool

	// The ARN for the Redshift application that integrates with IAM Identity Center.
	RedshiftIdcApplicationArn *string

	// A list of tag instances.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateNamespaceOutput

type CreateNamespaceOutput struct {

	// The created namespace object.
	Namespace *types.Namespace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateScheduledActionInput added in v1.15.0

type CreateScheduledActionInput struct {

	// The name of the namespace for which to create a scheduled action.
	//
	// This member is required.
	NamespaceName *string

	// The ARN of the IAM role to assume to run the scheduled action. This IAM role
	// must have permission to run the Amazon Redshift Serverless API operation in the
	// scheduled action. This IAM role must allow the Amazon Redshift scheduler to
	// schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to
	// assume permissions on your behalf. For more information about the IAM role to
	// use with the Amazon Redshift scheduler, see Using Identity-Based Policies for
	// Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html)
	// in the Amazon Redshift Cluster Management Guide
	//
	// This member is required.
	RoleArn *string

	// The schedule for a one-time (at format) or recurring (cron format) scheduled
	// action. Schedule invocations must be separated by at least one hour. Format of
	// at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, "
	// at(2016-03-04T17:27:00) ". Format of cron expressions is " cron(Minutes Hours
	// Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ".
	// For more information, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions)
	// in the Amazon CloudWatch Events User Guide.
	//
	// This member is required.
	Schedule types.Schedule

	// The name of the scheduled action.
	//
	// This member is required.
	ScheduledActionName *string

	// A JSON format string of the Amazon Redshift Serverless API operation with input
	// parameters. The following is an example of a target action. "{"CreateSnapshot":
	// {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot",
	// "retentionPeriod": "1"}}"
	//
	// This member is required.
	TargetAction types.TargetAction

	// Indicates whether the schedule is enabled. If false, the scheduled action does
	// not trigger. For more information about state of the scheduled action, see
	// ScheduledAction (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html)
	// .
	Enabled *bool

	// The end time in UTC when the schedule is no longer active. After this time, the
	// scheduled action does not trigger.
	EndTime *time.Time

	// The description of the scheduled action.
	ScheduledActionDescription *string

	// The start time in UTC when the schedule is active. Before this time, the
	// scheduled action does not trigger.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type CreateScheduledActionOutput added in v1.15.0

type CreateScheduledActionOutput struct {

	// The returned ScheduledAction object that describes the properties of a
	// scheduled action.
	ScheduledAction *types.ScheduledActionResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSnapshotCopyConfigurationInput added in v1.15.0

type CreateSnapshotCopyConfigurationInput struct {

	// The destination Amazon Web Services Region that you want to copy snapshots to.
	//
	// This member is required.
	DestinationRegion *string

	// The name of the namespace to copy snapshots from.
	//
	// This member is required.
	NamespaceName *string

	// The KMS key to use to encrypt your snapshots in the destination Amazon Web
	// Services Region.
	DestinationKmsKeyId *string

	// The retention period of the snapshots that you copy to the destination Amazon
	// Web Services Region.
	SnapshotRetentionPeriod *int32
	// contains filtered or unexported fields
}

type CreateSnapshotCopyConfigurationOutput added in v1.15.0

type CreateSnapshotCopyConfigurationOutput struct {

	// The snapshot copy configuration object that is returned.
	//
	// This member is required.
	SnapshotCopyConfiguration *types.SnapshotCopyConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSnapshotInput

type CreateSnapshotInput struct {

	// The namespace to create a snapshot for.
	//
	// This member is required.
	NamespaceName *string

	// The name of the snapshot.
	//
	// This member is required.
	SnapshotName *string

	// How long to retain the created snapshot.
	RetentionPeriod *int32

	// An array of Tag objects (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html)
	// to associate with the snapshot.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSnapshotOutput

type CreateSnapshotOutput struct {

	// The created snapshot object.
	Snapshot *types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUsageLimitInput

type CreateUsageLimitInput struct {

	// The limit amount. If time-based, this amount is in Redshift Processing Units
	// (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data
	// transferred between Regions in cross-account sharing. The value must be a
	// positive number.
	//
	// This member is required.
	Amount *int64

	// The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to
	// create the usage limit for.
	//
	// This member is required.
	ResourceArn *string

	// The type of Amazon Redshift Serverless usage to create a usage limit for.
	//
	// This member is required.
	UsageType types.UsageLimitUsageType

	// The action that Amazon Redshift Serverless takes when the limit is reached. The
	// default is log.
	BreachAction types.UsageLimitBreachAction

	// The time period that the amount applies to. A weekly period begins on Sunday.
	// The default is monthly.
	Period types.UsageLimitPeriod
	// contains filtered or unexported fields
}

type CreateUsageLimitOutput

type CreateUsageLimitOutput struct {

	// The returned usage limit object.
	UsageLimit *types.UsageLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkgroupInput

type CreateWorkgroupInput struct {

	// The name of the namespace to associate with the workgroup.
	//
	// This member is required.
	NamespaceName *string

	// The name of the created workgroup.
	//
	// This member is required.
	WorkgroupName *string

	// The base data warehouse capacity of the workgroup in Redshift Processing Units
	// (RPUs).
	BaseCapacity *int32

	// An array of parameters to set for advanced control over a database. The options
	// are auto_mv , datestyle , enable_case_sensitive_identifier ,
	// enable_user_activity_logging , query_group , search_path , require_ssl , and
	// query monitoring metrics that let you define performance boundaries. For more
	// information about query monitoring rules and available metrics, see Query
	// monitoring metrics for Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless)
	// .
	ConfigParameters []types.ConfigParameter

	// The value that specifies whether to turn on enhanced virtual private cloud
	// (VPC) routing, which forces Amazon Redshift Serverless to route traffic through
	// your VPC instead of over the internet.
	EnhancedVpcRouting *bool

	// The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve
	// queries. The max capacity is specified in RPUs.
	MaxCapacity *int32

	// The custom port to use when connecting to a workgroup. Valid port ranges are
	// 5431-5455 and 8191-8215. The default is 5439.
	Port *int32

	// A value that specifies whether the workgroup can be accessed from a public
	// network.
	PubliclyAccessible *bool

	// An array of security group IDs to associate with the workgroup.
	SecurityGroupIds []string

	// An array of VPC subnet IDs to associate with the workgroup.
	SubnetIds []string

	// A array of tag instances.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateWorkgroupOutput

type CreateWorkgroupOutput struct {

	// The created workgroup object.
	Workgroup *types.Workgroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomDomainAssociationInput added in v1.9.0

type DeleteCustomDomainAssociationInput struct {

	// The custom domain name associated with the workgroup.
	//
	// This member is required.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type DeleteCustomDomainAssociationOutput added in v1.9.0

type DeleteCustomDomainAssociationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEndpointAccessInput

type DeleteEndpointAccessInput struct {

	// The name of the VPC endpoint to delete.
	//
	// This member is required.
	EndpointName *string
	// contains filtered or unexported fields
}

type DeleteEndpointAccessOutput

type DeleteEndpointAccessOutput struct {

	// The deleted VPC endpoint.
	Endpoint *types.EndpointAccess

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNamespaceInput

type DeleteNamespaceInput struct {

	// The name of the namespace to delete.
	//
	// This member is required.
	NamespaceName *string

	// The name of the snapshot to be created before the namespace is deleted.
	FinalSnapshotName *string

	// How long to retain the final snapshot.
	FinalSnapshotRetentionPeriod *int32
	// contains filtered or unexported fields
}

type DeleteNamespaceOutput

type DeleteNamespaceOutput struct {

	// The deleted namespace object.
	//
	// This member is required.
	Namespace *types.Namespace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyInput

type DeleteResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the policy to delete.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyOutput

type DeleteResourcePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteScheduledActionInput added in v1.15.0

type DeleteScheduledActionInput struct {

	// The name of the scheduled action to delete.
	//
	// This member is required.
	ScheduledActionName *string
	// contains filtered or unexported fields
}

type DeleteScheduledActionOutput added in v1.15.0

type DeleteScheduledActionOutput struct {

	// The deleted scheduled action object.
	ScheduledAction *types.ScheduledActionResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSnapshotCopyConfigurationInput added in v1.15.0

type DeleteSnapshotCopyConfigurationInput struct {

	// The ID of the snapshot copy configuration to delete.
	//
	// This member is required.
	SnapshotCopyConfigurationId *string
	// contains filtered or unexported fields
}

type DeleteSnapshotCopyConfigurationOutput added in v1.15.0

type DeleteSnapshotCopyConfigurationOutput struct {

	// The deleted snapshot copy configuration object.
	//
	// This member is required.
	SnapshotCopyConfiguration *types.SnapshotCopyConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSnapshotInput

type DeleteSnapshotInput struct {

	// The name of the snapshot to be deleted.
	//
	// This member is required.
	SnapshotName *string
	// contains filtered or unexported fields
}

type DeleteSnapshotOutput

type DeleteSnapshotOutput struct {

	// The deleted snapshot object.
	Snapshot *types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteUsageLimitInput

type DeleteUsageLimitInput struct {

	// The unique identifier of the usage limit to delete.
	//
	// This member is required.
	UsageLimitId *string
	// contains filtered or unexported fields
}

type DeleteUsageLimitOutput

type DeleteUsageLimitOutput struct {

	// The deleted usage limit object.
	UsageLimit *types.UsageLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkgroupInput

type DeleteWorkgroupInput struct {

	// The name of the workgroup to be deleted.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type DeleteWorkgroupOutput

type DeleteWorkgroupOutput struct {

	// The deleted workgroup object.
	//
	// This member is required.
	Workgroup *types.Workgroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.5.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.5.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.5.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.5.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.5.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCredentialsInput

type GetCredentialsInput struct {

	// The custom domain name associated with the workgroup. The custom domain name or
	// the workgroup name must be included in the request.
	CustomDomainName *string

	// The name of the database to get temporary authorization to log on to.
	// Constraints:
	//   - Must be 1 to 64 alphanumeric characters or hyphens.
	//   - Must contain only uppercase or lowercase letters, numbers, underscore, plus
	//   sign, period (dot), at symbol (@), or hyphen.
	//   - The first character must be a letter.
	//   - Must not contain a colon ( : ) or slash ( / ).
	//   - Cannot be a reserved word. A list of reserved words can be found in
	//   Reserved Words  (https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html)
	//   in the Amazon Redshift Database Developer Guide
	DbName *string

	// The number of seconds until the returned temporary password expires. The
	// minimum is 900 seconds, and the maximum is 3600 seconds.
	DurationSeconds *int32

	// The name of the workgroup associated with the database.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type GetCredentialsOutput

type GetCredentialsOutput struct {

	// A temporary password that authorizes the user name returned by DbUser to log on
	// to the database DbName .
	DbPassword *string

	// A database user name that is authorized to log on to the database DbName using
	// the password DbPassword . If the specified DbUser exists in the database, the
	// new user name has the same database privileges as the the user named in DbUser .
	// By default, the user is added to PUBLIC.
	DbUser *string

	// The date and time the password in DbPassword expires.
	Expiration *time.Time

	// The date and time of when the DbUser and DbPassword authorization refreshes.
	NextRefreshTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCustomDomainAssociationInput added in v1.9.0

type GetCustomDomainAssociationInput struct {

	// The custom domain name associated with the workgroup.
	//
	// This member is required.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type GetCustomDomainAssociationOutput added in v1.9.0

type GetCustomDomainAssociationOutput struct {

	// The custom domain name’s certificate Amazon resource name (ARN).
	CustomDomainCertificateArn *string

	// The expiration time for the certificate.
	CustomDomainCertificateExpiryTime *time.Time

	// The custom domain name associated with the workgroup.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	WorkgroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEndpointAccessInput

type GetEndpointAccessInput struct {

	// The name of the VPC endpoint to return information for.
	//
	// This member is required.
	EndpointName *string
	// contains filtered or unexported fields
}

type GetEndpointAccessOutput

type GetEndpointAccessOutput struct {

	// The returned VPC endpoint.
	Endpoint *types.EndpointAccess

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetNamespaceInput

type GetNamespaceInput struct {

	// The name of the namespace to retrieve information for.
	//
	// This member is required.
	NamespaceName *string
	// contains filtered or unexported fields
}

type GetNamespaceOutput

type GetNamespaceOutput struct {

	// The returned namespace object.
	//
	// This member is required.
	Namespace *types.Namespace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRecoveryPointInput

type GetRecoveryPointInput struct {

	// The unique identifier of the recovery point to return information for.
	//
	// This member is required.
	RecoveryPointId *string
	// contains filtered or unexported fields
}

type GetRecoveryPointOutput

type GetRecoveryPointOutput struct {

	// The returned recovery point object.
	RecoveryPoint *types.RecoveryPoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourcePolicyInput

type GetResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the resource to return.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type GetResourcePolicyOutput

type GetResourcePolicyOutput struct {

	// The returned resource policy.
	ResourcePolicy *types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetScheduledActionInput added in v1.15.0

type GetScheduledActionInput struct {

	// The name of the scheduled action.
	//
	// This member is required.
	ScheduledActionName *string
	// contains filtered or unexported fields
}

type GetScheduledActionOutput added in v1.15.0

type GetScheduledActionOutput struct {

	// The returned scheduled action object.
	ScheduledAction *types.ScheduledActionResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSnapshotInput

type GetSnapshotInput struct {

	// The owner Amazon Web Services account of a snapshot shared with another user.
	OwnerAccount *string

	// The Amazon Resource Name (ARN) of the snapshot to return.
	SnapshotArn *string

	// The name of the snapshot to return.
	SnapshotName *string
	// contains filtered or unexported fields
}

type GetSnapshotOutput

type GetSnapshotOutput struct {

	// The returned snapshot object.
	Snapshot *types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTableRestoreStatusInput added in v1.3.0

type GetTableRestoreStatusInput struct {

	// The ID of the RestoreTableFromSnapshot request to return status for.
	//
	// This member is required.
	TableRestoreRequestId *string
	// contains filtered or unexported fields
}

type GetTableRestoreStatusOutput added in v1.3.0

type GetTableRestoreStatusOutput struct {

	// The returned TableRestoreStatus object that contains information about the
	// status of your RestoreTableFromSnapshot request.
	TableRestoreStatus *types.TableRestoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetUsageLimitInput

type GetUsageLimitInput struct {

	// The unique identifier of the usage limit to return information for.
	//
	// This member is required.
	UsageLimitId *string
	// contains filtered or unexported fields
}

type GetUsageLimitOutput

type GetUsageLimitOutput struct {

	// The returned usage limit object.
	UsageLimit *types.UsageLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkgroupInput

type GetWorkgroupInput struct {

	// The name of the workgroup to return information for.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type GetWorkgroupOutput

type GetWorkgroupOutput struct {

	// The returned workgroup object.
	//
	// This member is required.
	Workgroup *types.Workgroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListCustomDomainAssociationsAPIClient added in v1.9.0

type ListCustomDomainAssociationsAPIClient interface {
	ListCustomDomainAssociations(context.Context, *ListCustomDomainAssociationsInput, ...func(*Options)) (*ListCustomDomainAssociationsOutput, error)
}

ListCustomDomainAssociationsAPIClient is a client that implements the ListCustomDomainAssociations operation.

type ListCustomDomainAssociationsInput added in v1.9.0

type ListCustomDomainAssociationsInput struct {

	// The custom domain name’s certificate Amazon resource name (ARN).
	CustomDomainCertificateArn *string

	// The custom domain name associated with the workgroup.
	CustomDomainName *string

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomDomainAssociationsOutput added in v1.9.0

type ListCustomDomainAssociationsOutput struct {

	// A list of Association objects.
	Associations []types.Association

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomDomainAssociationsPaginator added in v1.9.0

type ListCustomDomainAssociationsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomDomainAssociationsPaginator is a paginator for ListCustomDomainAssociations

func NewListCustomDomainAssociationsPaginator added in v1.9.0

NewListCustomDomainAssociationsPaginator returns a new ListCustomDomainAssociationsPaginator

func (*ListCustomDomainAssociationsPaginator) HasMorePages added in v1.9.0

func (p *ListCustomDomainAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomDomainAssociationsPaginator) NextPage added in v1.9.0

NextPage retrieves the next ListCustomDomainAssociations page.

type ListCustomDomainAssociationsPaginatorOptions added in v1.9.0

type ListCustomDomainAssociationsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomDomainAssociationsPaginatorOptions is the paginator options for ListCustomDomainAssociations

type ListEndpointAccessAPIClient

type ListEndpointAccessAPIClient interface {
	ListEndpointAccess(context.Context, *ListEndpointAccessInput, ...func(*Options)) (*ListEndpointAccessOutput, error)
}

ListEndpointAccessAPIClient is a client that implements the ListEndpointAccess operation.

type ListEndpointAccessInput

type ListEndpointAccessInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// If your initial ListEndpointAccess operation returns a nextToken , you can
	// include the returned nextToken in following ListEndpointAccess operations,
	// which returns results in the next page.
	NextToken *string

	// The owner Amazon Web Services account for the Amazon Redshift Serverless
	// workgroup.
	OwnerAccount *string

	// The unique identifier of the virtual private cloud with access to Amazon
	// Redshift Serverless.
	VpcId *string

	// The name of the workgroup associated with the VPC endpoint to return.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type ListEndpointAccessOutput

type ListEndpointAccessOutput struct {

	// The returned VPC endpoints.
	//
	// This member is required.
	Endpoints []types.EndpointAccess

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEndpointAccessPaginator

type ListEndpointAccessPaginator struct {
	// contains filtered or unexported fields
}

ListEndpointAccessPaginator is a paginator for ListEndpointAccess

func NewListEndpointAccessPaginator

func NewListEndpointAccessPaginator(client ListEndpointAccessAPIClient, params *ListEndpointAccessInput, optFns ...func(*ListEndpointAccessPaginatorOptions)) *ListEndpointAccessPaginator

NewListEndpointAccessPaginator returns a new ListEndpointAccessPaginator

func (*ListEndpointAccessPaginator) HasMorePages

func (p *ListEndpointAccessPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointAccessPaginator) NextPage

func (p *ListEndpointAccessPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointAccessOutput, error)

NextPage retrieves the next ListEndpointAccess page.

type ListEndpointAccessPaginatorOptions

type ListEndpointAccessPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEndpointAccessPaginatorOptions is the paginator options for ListEndpointAccess

type ListNamespacesAPIClient

type ListNamespacesAPIClient interface {
	ListNamespaces(context.Context, *ListNamespacesInput, ...func(*Options)) (*ListNamespacesOutput, error)
}

ListNamespacesAPIClient is a client that implements the ListNamespaces operation.

type ListNamespacesInput

type ListNamespacesInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// If your initial ListNamespaces operation returns a nextToken , you can include
	// the returned nextToken in following ListNamespaces operations, which returns
	// results in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNamespacesOutput

type ListNamespacesOutput struct {

	// The list of returned namespaces.
	//
	// This member is required.
	Namespaces []types.Namespace

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNamespacesPaginator

type ListNamespacesPaginator struct {
	// contains filtered or unexported fields
}

ListNamespacesPaginator is a paginator for ListNamespaces

func NewListNamespacesPaginator

func NewListNamespacesPaginator(client ListNamespacesAPIClient, params *ListNamespacesInput, optFns ...func(*ListNamespacesPaginatorOptions)) *ListNamespacesPaginator

NewListNamespacesPaginator returns a new ListNamespacesPaginator

func (*ListNamespacesPaginator) HasMorePages

func (p *ListNamespacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNamespacesPaginator) NextPage

func (p *ListNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamespacesOutput, error)

NextPage retrieves the next ListNamespaces page.

type ListNamespacesPaginatorOptions

type ListNamespacesPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNamespacesPaginatorOptions is the paginator options for ListNamespaces

type ListRecoveryPointsAPIClient

type ListRecoveryPointsAPIClient interface {
	ListRecoveryPoints(context.Context, *ListRecoveryPointsInput, ...func(*Options)) (*ListRecoveryPointsOutput, error)
}

ListRecoveryPointsAPIClient is a client that implements the ListRecoveryPoints operation.

type ListRecoveryPointsInput

type ListRecoveryPointsInput struct {

	// The time when creation of the recovery point finished.
	EndTime *time.Time

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// The Amazon Resource Name (ARN) of the namespace from which to list recovery
	// points.
	NamespaceArn *string

	// The name of the namespace to list recovery points for.
	NamespaceName *string

	// If your initial ListRecoveryPoints operation returns a nextToken , you can
	// include the returned nextToken in following ListRecoveryPoints operations,
	// which returns results in the next page.
	NextToken *string

	// The time when the recovery point's creation was initiated.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListRecoveryPointsOutput

type ListRecoveryPointsOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The returned recovery point objects.
	RecoveryPoints []types.RecoveryPoint

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecoveryPointsPaginator

type ListRecoveryPointsPaginator struct {
	// contains filtered or unexported fields
}

ListRecoveryPointsPaginator is a paginator for ListRecoveryPoints

func NewListRecoveryPointsPaginator

func NewListRecoveryPointsPaginator(client ListRecoveryPointsAPIClient, params *ListRecoveryPointsInput, optFns ...func(*ListRecoveryPointsPaginatorOptions)) *ListRecoveryPointsPaginator

NewListRecoveryPointsPaginator returns a new ListRecoveryPointsPaginator

func (*ListRecoveryPointsPaginator) HasMorePages

func (p *ListRecoveryPointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecoveryPointsPaginator) NextPage

func (p *ListRecoveryPointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecoveryPointsOutput, error)

NextPage retrieves the next ListRecoveryPoints page.

type ListRecoveryPointsPaginatorOptions

type ListRecoveryPointsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecoveryPointsPaginatorOptions is the paginator options for ListRecoveryPoints

type ListScheduledActionsAPIClient added in v1.15.0

type ListScheduledActionsAPIClient interface {
	ListScheduledActions(context.Context, *ListScheduledActionsInput, ...func(*Options)) (*ListScheduledActionsOutput, error)
}

ListScheduledActionsAPIClient is a client that implements the ListScheduledActions operation.

type ListScheduledActionsInput added in v1.15.0

type ListScheduledActionsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// Use nextToken to display the next page of results.
	MaxResults *int32

	// The name of namespace associated with the scheduled action to retrieve.
	NamespaceName *string

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListScheduledActionsOutput added in v1.15.0

type ListScheduledActionsOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// All of the returned scheduled action objects.
	ScheduledActions []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListScheduledActionsPaginator added in v1.15.0

type ListScheduledActionsPaginator struct {
	// contains filtered or unexported fields
}

ListScheduledActionsPaginator is a paginator for ListScheduledActions

func NewListScheduledActionsPaginator added in v1.15.0

NewListScheduledActionsPaginator returns a new ListScheduledActionsPaginator

func (*ListScheduledActionsPaginator) HasMorePages added in v1.15.0

func (p *ListScheduledActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScheduledActionsPaginator) NextPage added in v1.15.0

NextPage retrieves the next ListScheduledActions page.

type ListScheduledActionsPaginatorOptions added in v1.15.0

type ListScheduledActionsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// Use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListScheduledActionsPaginatorOptions is the paginator options for ListScheduledActions

type ListSnapshotCopyConfigurationsAPIClient added in v1.15.0

type ListSnapshotCopyConfigurationsAPIClient interface {
	ListSnapshotCopyConfigurations(context.Context, *ListSnapshotCopyConfigurationsInput, ...func(*Options)) (*ListSnapshotCopyConfigurationsOutput, error)
}

ListSnapshotCopyConfigurationsAPIClient is a client that implements the ListSnapshotCopyConfigurations operation.

type ListSnapshotCopyConfigurationsInput added in v1.15.0

type ListSnapshotCopyConfigurationsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// The namespace from which to list all snapshot copy configurations.
	NamespaceName *string

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSnapshotCopyConfigurationsOutput added in v1.15.0

type ListSnapshotCopyConfigurationsOutput struct {

	// All of the returned snapshot copy configurations.
	//
	// This member is required.
	SnapshotCopyConfigurations []types.SnapshotCopyConfiguration

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSnapshotCopyConfigurationsPaginator added in v1.15.0

type ListSnapshotCopyConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListSnapshotCopyConfigurationsPaginator is a paginator for ListSnapshotCopyConfigurations

func NewListSnapshotCopyConfigurationsPaginator added in v1.15.0

NewListSnapshotCopyConfigurationsPaginator returns a new ListSnapshotCopyConfigurationsPaginator

func (*ListSnapshotCopyConfigurationsPaginator) HasMorePages added in v1.15.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSnapshotCopyConfigurationsPaginator) NextPage added in v1.15.0

NextPage retrieves the next ListSnapshotCopyConfigurations page.

type ListSnapshotCopyConfigurationsPaginatorOptions added in v1.15.0

type ListSnapshotCopyConfigurationsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSnapshotCopyConfigurationsPaginatorOptions is the paginator options for ListSnapshotCopyConfigurations

type ListSnapshotsAPIClient

type ListSnapshotsAPIClient interface {
	ListSnapshots(context.Context, *ListSnapshotsInput, ...func(*Options)) (*ListSnapshotsOutput, error)
}

ListSnapshotsAPIClient is a client that implements the ListSnapshots operation.

type ListSnapshotsInput

type ListSnapshotsInput struct {

	// The timestamp showing when the snapshot creation finished.
	EndTime *time.Time

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// The Amazon Resource Name (ARN) of the namespace from which to list all
	// snapshots.
	NamespaceArn *string

	// The namespace from which to list all snapshots.
	NamespaceName *string

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// The owner Amazon Web Services account of the snapshot.
	OwnerAccount *string

	// The time when the creation of the snapshot was initiated.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListSnapshotsOutput

type ListSnapshotsOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// All of the returned snapshot objects.
	Snapshots []types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSnapshotsPaginator

type ListSnapshotsPaginator struct {
	// contains filtered or unexported fields
}

ListSnapshotsPaginator is a paginator for ListSnapshots

func NewListSnapshotsPaginator

func NewListSnapshotsPaginator(client ListSnapshotsAPIClient, params *ListSnapshotsInput, optFns ...func(*ListSnapshotsPaginatorOptions)) *ListSnapshotsPaginator

NewListSnapshotsPaginator returns a new ListSnapshotsPaginator

func (*ListSnapshotsPaginator) HasMorePages

func (p *ListSnapshotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSnapshotsPaginator) NextPage

func (p *ListSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSnapshotsOutput, error)

NextPage retrieves the next ListSnapshots page.

type ListSnapshotsPaginatorOptions

type ListSnapshotsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSnapshotsPaginatorOptions is the paginator options for ListSnapshots

type ListTableRestoreStatusAPIClient added in v1.3.0

type ListTableRestoreStatusAPIClient interface {
	ListTableRestoreStatus(context.Context, *ListTableRestoreStatusInput, ...func(*Options)) (*ListTableRestoreStatusOutput, error)
}

ListTableRestoreStatusAPIClient is a client that implements the ListTableRestoreStatus operation.

type ListTableRestoreStatusInput added in v1.3.0

type ListTableRestoreStatusInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// The namespace from which to list all of the statuses of RestoreTableFromSnapshot
	// operations .
	NamespaceName *string

	// If your initial ListTableRestoreStatus operation returns a nextToken, you can
	// include the returned nextToken in following ListTableRestoreStatus operations.
	// This will return results on the next page.
	NextToken *string

	// The workgroup from which to list all of the statuses of RestoreTableFromSnapshot
	// operations.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type ListTableRestoreStatusOutput added in v1.3.0

type ListTableRestoreStatusOutput struct {

	// If your initial ListTableRestoreStatus operation returns a nextToken , you can
	// include the returned nextToken in following ListTableRestoreStatus operations.
	// This will returns results on the next page.
	NextToken *string

	// The array of returned TableRestoreStatus objects.
	TableRestoreStatuses []types.TableRestoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTableRestoreStatusPaginator added in v1.3.0

type ListTableRestoreStatusPaginator struct {
	// contains filtered or unexported fields
}

ListTableRestoreStatusPaginator is a paginator for ListTableRestoreStatus

func NewListTableRestoreStatusPaginator added in v1.3.0

NewListTableRestoreStatusPaginator returns a new ListTableRestoreStatusPaginator

func (*ListTableRestoreStatusPaginator) HasMorePages added in v1.3.0

func (p *ListTableRestoreStatusPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTableRestoreStatusPaginator) NextPage added in v1.3.0

NextPage retrieves the next ListTableRestoreStatus page.

type ListTableRestoreStatusPaginatorOptions added in v1.3.0

type ListTableRestoreStatusPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTableRestoreStatusPaginatorOptions is the paginator options for ListTableRestoreStatus

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to list tags for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A map of the key-value pairs assigned to the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsageLimitsAPIClient

type ListUsageLimitsAPIClient interface {
	ListUsageLimits(context.Context, *ListUsageLimitsInput, ...func(*Options)) (*ListUsageLimitsOutput, error)
}

ListUsageLimitsAPIClient is a client that implements the ListUsageLimits operation.

type ListUsageLimitsInput

type ListUsageLimitsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 100.
	MaxResults *int32

	// If your initial ListUsageLimits operation returns a nextToken , you can include
	// the returned nextToken in following ListUsageLimits operations, which returns
	// results in the next page.
	NextToken *string

	// The Amazon Resource Name (ARN) associated with the resource whose usage limits
	// you want to list.
	ResourceArn *string

	// The Amazon Redshift Serverless feature whose limits you want to see.
	UsageType types.UsageLimitUsageType
	// contains filtered or unexported fields
}

type ListUsageLimitsOutput

type ListUsageLimitsOutput struct {

	// When nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again using
	// the returned token to retrieve the next page.
	NextToken *string

	// An array of returned usage limit objects.
	UsageLimits []types.UsageLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListUsageLimitsPaginator

type ListUsageLimitsPaginator struct {
	// contains filtered or unexported fields
}

ListUsageLimitsPaginator is a paginator for ListUsageLimits

func NewListUsageLimitsPaginator

func NewListUsageLimitsPaginator(client ListUsageLimitsAPIClient, params *ListUsageLimitsInput, optFns ...func(*ListUsageLimitsPaginatorOptions)) *ListUsageLimitsPaginator

NewListUsageLimitsPaginator returns a new ListUsageLimitsPaginator

func (*ListUsageLimitsPaginator) HasMorePages

func (p *ListUsageLimitsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUsageLimitsPaginator) NextPage

func (p *ListUsageLimitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsageLimitsOutput, error)

NextPage retrieves the next ListUsageLimits page.

type ListUsageLimitsPaginatorOptions

type ListUsageLimitsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to get the next page of results. The default is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListUsageLimitsPaginatorOptions is the paginator options for ListUsageLimits

type ListWorkgroupsAPIClient

type ListWorkgroupsAPIClient interface {
	ListWorkgroups(context.Context, *ListWorkgroupsInput, ...func(*Options)) (*ListWorkgroupsOutput, error)
}

ListWorkgroupsAPIClient is a client that implements the ListWorkgroups operation.

type ListWorkgroupsInput

type ListWorkgroupsInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// If your initial ListWorkgroups operation returns a nextToken , you can include
	// the returned nextToken in following ListNamespaces operations, which returns
	// results in the next page.
	NextToken *string

	// The owner Amazon Web Services account for the Amazon Redshift Serverless
	// workgroup.
	OwnerAccount *string
	// contains filtered or unexported fields
}

type ListWorkgroupsOutput

type ListWorkgroupsOutput struct {

	// The returned array of workgroups.
	//
	// This member is required.
	Workgroups []types.Workgroup

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. To retrieve the next page,
	// make the call again using the returned token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListWorkgroupsPaginator

type ListWorkgroupsPaginator struct {
	// contains filtered or unexported fields
}

ListWorkgroupsPaginator is a paginator for ListWorkgroups

func NewListWorkgroupsPaginator

func NewListWorkgroupsPaginator(client ListWorkgroupsAPIClient, params *ListWorkgroupsInput, optFns ...func(*ListWorkgroupsPaginatorOptions)) *ListWorkgroupsPaginator

NewListWorkgroupsPaginator returns a new ListWorkgroupsPaginator

func (*ListWorkgroupsPaginator) HasMorePages

func (p *ListWorkgroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkgroupsPaginator) NextPage

func (p *ListWorkgroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkgroupsOutput, error)

NextPage retrieves the next ListWorkgroups page.

type ListWorkgroupsPaginatorOptions

type ListWorkgroupsPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkgroupsPaginatorOptions is the paginator options for ListWorkgroups

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.12.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutResourcePolicyInput

type PutResourcePolicyInput struct {

	// The policy to create or update. For example, the following policy grants a user
	// authorization to restore a snapshot. "{\"Version\": \"2012-10-17\",
	// \"Statement\" : [{ \"Sid\": \"AllowUserRestoreFromSnapshot\",
	// \"Principal\":{\"AWS\": [\"739247239426\"]}, \"Action\":
	// [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}"
	//
	// This member is required.
	Policy *string

	// The Amazon Resource Name (ARN) of the account to create or update a resource
	// policy for.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type PutResourcePolicyOutput

type PutResourcePolicyOutput struct {

	// The policy that was created or updated.
	ResourcePolicy *types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RestoreFromRecoveryPointInput

type RestoreFromRecoveryPointInput struct {

	// The name of the namespace to restore data into.
	//
	// This member is required.
	NamespaceName *string

	// The unique identifier of the recovery point to restore from.
	//
	// This member is required.
	RecoveryPointId *string

	// The name of the workgroup used to restore data.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type RestoreFromRecoveryPointOutput

type RestoreFromRecoveryPointOutput struct {

	// The namespace that data was restored into.
	Namespace *types.Namespace

	// The unique identifier of the recovery point used for the restore.
	RecoveryPointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RestoreFromSnapshotInput

type RestoreFromSnapshotInput struct {

	// The name of the namespace to restore the snapshot to.
	//
	// This member is required.
	NamespaceName *string

	// The name of the workgroup used to restore the snapshot.
	//
	// This member is required.
	WorkgroupName *string

	// The ID of the Key Management Service (KMS) key used to encrypt and store the
	// namespace's admin credentials secret.
	AdminPasswordSecretKmsKeyId *string

	// If true , Amazon Redshift uses Secrets Manager to manage the restored snapshot's
	// admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift
	// uses the admin credentials that the namespace or cluster had at the time the
	// snapshot was taken.
	ManageAdminPassword *bool

	// The Amazon Web Services account that owns the snapshot.
	OwnerAccount *string

	// The Amazon Resource Name (ARN) of the snapshot to restore from. Required if
	// restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be
	// specified at the same time as snapshotName . The format of the ARN is
	// arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
	SnapshotArn *string

	// The name of the snapshot to restore from. Must not be specified at the same
	// time as snapshotArn .
	SnapshotName *string
	// contains filtered or unexported fields
}

type RestoreFromSnapshotOutput

type RestoreFromSnapshotOutput struct {

	// A collection of database objects and users.
	Namespace *types.Namespace

	// The owner Amazon Web Services; account of the snapshot that was restored.
	OwnerAccount *string

	// The name of the snapshot used to restore the namespace.
	SnapshotName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RestoreTableFromRecoveryPointInput added in v1.15.0

type RestoreTableFromRecoveryPointInput struct {

	// Namespace of the recovery point to restore from.
	//
	// This member is required.
	NamespaceName *string

	// The name of the table to create from the restore operation.
	//
	// This member is required.
	NewTableName *string

	// The ID of the recovery point to restore the table from.
	//
	// This member is required.
	RecoveryPointId *string

	// The name of the source database that contains the table being restored.
	//
	// This member is required.
	SourceDatabaseName *string

	// The name of the source table being restored.
	//
	// This member is required.
	SourceTableName *string

	// The workgroup to restore the table to.
	//
	// This member is required.
	WorkgroupName *string

	// Indicates whether name identifiers for database, schema, and table are case
	// sensitive. If true, the names are case sensitive. If false, the names are not
	// case sensitive. The default is false.
	ActivateCaseSensitiveIdentifier *bool

	// The name of the source schema that contains the table being restored.
	SourceSchemaName *string

	// The name of the database to restore the table to.
	TargetDatabaseName *string

	// The name of the schema to restore the table to.
	TargetSchemaName *string
	// contains filtered or unexported fields
}

type RestoreTableFromRecoveryPointOutput added in v1.15.0

type RestoreTableFromRecoveryPointOutput struct {

	// Contains information about a table restore request.
	TableRestoreStatus *types.TableRestoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RestoreTableFromSnapshotInput added in v1.3.0

type RestoreTableFromSnapshotInput struct {

	// The namespace of the snapshot to restore from.
	//
	// This member is required.
	NamespaceName *string

	// The name of the table to create from the restore operation.
	//
	// This member is required.
	NewTableName *string

	// The name of the snapshot to restore the table from.
	//
	// This member is required.
	SnapshotName *string

	// The name of the source database that contains the table being restored.
	//
	// This member is required.
	SourceDatabaseName *string

	// The name of the source table being restored.
	//
	// This member is required.
	SourceTableName *string

	// The workgroup to restore the table to.
	//
	// This member is required.
	WorkgroupName *string

	// Indicates whether name identifiers for database, schema, and table are case
	// sensitive. If true, the names are case sensitive. If false, the names are not
	// case sensitive. The default is false.
	ActivateCaseSensitiveIdentifier *bool

	// The name of the source schema that contains the table being restored.
	SourceSchemaName *string

	// The name of the database to restore the table to.
	TargetDatabaseName *string

	// The name of the schema to restore the table to.
	TargetSchemaName *string
	// contains filtered or unexported fields
}

type RestoreTableFromSnapshotOutput added in v1.3.0

type RestoreTableFromSnapshotOutput struct {

	// The TableRestoreStatus object that contains the status of the restore operation.
	TableRestoreStatus *types.TableRestoreStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// This member is required.
	ResourceArn *string

	// The map of the key-value pairs used to tag the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to remove tags from.
	//
	// This member is required.
	ResourceArn *string

	// The tag or set of tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomDomainAssociationInput added in v1.9.0

type UpdateCustomDomainAssociationInput struct {

	// The custom domain name’s certificate Amazon resource name (ARN). This is
	// optional.
	//
	// This member is required.
	CustomDomainCertificateArn *string

	// The custom domain name associated with the workgroup.
	//
	// This member is required.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	//
	// This member is required.
	WorkgroupName *string
	// contains filtered or unexported fields
}

type UpdateCustomDomainAssociationOutput added in v1.9.0

type UpdateCustomDomainAssociationOutput struct {

	// The custom domain name’s certificate Amazon resource name (ARN).
	CustomDomainCertificateArn *string

	// The expiration time for the certificate.
	CustomDomainCertificateExpiryTime *time.Time

	// The custom domain name associated with the workgroup.
	CustomDomainName *string

	// The name of the workgroup associated with the database.
	WorkgroupName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEndpointAccessInput

type UpdateEndpointAccessInput struct {

	// The name of the VPC endpoint to update.
	//
	// This member is required.
	EndpointName *string

	// The list of VPC security groups associated with the endpoint after the endpoint
	// is modified.
	VpcSecurityGroupIds []string
	// contains filtered or unexported fields
}

type UpdateEndpointAccessOutput

type UpdateEndpointAccessOutput struct {

	// The updated VPC endpoint.
	Endpoint *types.EndpointAccess

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNamespaceInput

type UpdateNamespaceInput struct {

	// The name of the namespace to update. You can't update the name of a namespace
	// once it is created.
	//
	// This member is required.
	NamespaceName *string

	// The ID of the Key Management Service (KMS) key used to encrypt and store the
	// namespace's admin credentials secret. You can only use this parameter if
	// manageAdminPassword is true.
	AdminPasswordSecretKmsKeyId *string

	// The password of the administrator for the first database created in the
	// namespace. This parameter must be updated together with adminUsername . You
	// can't use adminUserPassword if manageAdminPassword is true.
	AdminUserPassword *string

	// The username of the administrator for the first database created in the
	// namespace. This parameter must be updated together with adminUserPassword .
	AdminUsername *string

	// The Amazon Resource Name (ARN) of the IAM role to set as a default in the
	// namespace. This parameter must be updated together with iamRoles .
	DefaultIamRoleArn *string

	// A list of IAM roles to associate with the namespace. This parameter must be
	// updated together with defaultIamRoleArn .
	IamRoles []string

	// The ID of the Amazon Web Services Key Management Service key used to encrypt
	// your data.
	KmsKeyId *string

	// The types of logs the namespace can export. The export types are userlog ,
	// connectionlog , and useractivitylog .
	LogExports []types.LogExport

	// If true , Amazon Redshift uses Secrets Manager to manage the namespace's admin
	// credentials. You can't use adminUserPassword if manageAdminPassword is true. If
	// manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword
	// for the admin user account's password.
	ManageAdminPassword *bool
	// contains filtered or unexported fields
}

type UpdateNamespaceOutput

type UpdateNamespaceOutput struct {

	// A list of tag instances.
	//
	// This member is required.
	Namespace *types.Namespace

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateScheduledActionInput added in v1.15.0

type UpdateScheduledActionInput struct {

	// The name of the scheduled action to update to.
	//
	// This member is required.
	ScheduledActionName *string

	// Specifies whether to enable the scheduled action.
	Enabled *bool

	// The end time in UTC of the scheduled action to update.
	EndTime *time.Time

	// The ARN of the IAM role to assume to run the scheduled action. This IAM role
	// must have permission to run the Amazon Redshift Serverless API operation in the
	// scheduled action. This IAM role must allow the Amazon Redshift scheduler to
	// schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to
	// assume permissions on your behalf. For more information about the IAM role to
	// use with the Amazon Redshift scheduler, see Using Identity-Based Policies for
	// Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html)
	// in the Amazon Redshift Cluster Management Guide
	RoleArn *string

	// The schedule for a one-time (at format) or recurring (cron format) scheduled
	// action. Schedule invocations must be separated by at least one hour. Format of
	// at expressions is " at(yyyy-mm-ddThh:mm:ss) ". For example, "
	// at(2016-03-04T17:27:00) ". Format of cron expressions is " cron(Minutes Hours
	// Day-of-month Month Day-of-week Year) ". For example, " cron(0 10 ? * MON *) ".
	// For more information, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions)
	// in the Amazon CloudWatch Events User Guide.
	Schedule types.Schedule

	// The descripion of the scheduled action to update to.
	ScheduledActionDescription *string

	// The start time in UTC of the scheduled action to update to.
	StartTime *time.Time

	// A JSON format string of the Amazon Redshift Serverless API operation with input
	// parameters. The following is an example of a target action. "{"CreateSnapshot":
	// {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot",
	// "retentionPeriod": "1"}}"
	TargetAction types.TargetAction
	// contains filtered or unexported fields
}

type UpdateScheduledActionOutput added in v1.15.0

type UpdateScheduledActionOutput struct {

	// The ScheduledAction object that was updated.
	ScheduledAction *types.ScheduledActionResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSnapshotCopyConfigurationInput added in v1.15.0

type UpdateSnapshotCopyConfigurationInput struct {

	// The ID of the snapshot copy configuration to update.
	//
	// This member is required.
	SnapshotCopyConfigurationId *string

	// The new retention period of how long to keep a snapshot in the destination
	// Amazon Web Services Region.
	SnapshotRetentionPeriod *int32
	// contains filtered or unexported fields
}

type UpdateSnapshotCopyConfigurationOutput added in v1.15.0

type UpdateSnapshotCopyConfigurationOutput struct {

	// The updated snapshot copy configuration object.
	//
	// This member is required.
	SnapshotCopyConfiguration *types.SnapshotCopyConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSnapshotInput

type UpdateSnapshotInput struct {

	// The name of the snapshot.
	//
	// This member is required.
	SnapshotName *string

	// The new retention period of the snapshot.
	RetentionPeriod *int32
	// contains filtered or unexported fields
}

type UpdateSnapshotOutput

type UpdateSnapshotOutput struct {

	// The updated snapshot object.
	Snapshot *types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateUsageLimitInput

type UpdateUsageLimitInput struct {

	// The identifier of the usage limit to update.
	//
	// This member is required.
	UsageLimitId *string

	// The new limit amount. If time-based, this amount is in Redshift Processing
	// Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB)
	// of data transferred between Regions in cross-account sharing. The value must be
	// a positive number.
	Amount *int64

	// The new action that Amazon Redshift Serverless takes when the limit is reached.
	BreachAction types.UsageLimitBreachAction
	// contains filtered or unexported fields
}

type UpdateUsageLimitOutput

type UpdateUsageLimitOutput struct {

	// The updated usage limit object.
	UsageLimit *types.UsageLimit

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkgroupInput

type UpdateWorkgroupInput struct {

	// The name of the workgroup to update. You can't update the name of a workgroup
	// once it is created.
	//
	// This member is required.
	WorkgroupName *string

	// The new base data warehouse capacity in Redshift Processing Units (RPUs).
	BaseCapacity *int32

	// An array of parameters to set for advanced control over a database. The options
	// are auto_mv , datestyle , enable_case_sensitive_identifier ,
	// enable_user_activity_logging , query_group , search_path , require_ssl , and
	// query monitoring metrics that let you define performance boundaries. For more
	// information about query monitoring rules and available metrics, see Query
	// monitoring metrics for Amazon Redshift Serverless (https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless)
	// .
	ConfigParameters []types.ConfigParameter

	// The value that specifies whether to turn on enhanced virtual private cloud
	// (VPC) routing, which forces Amazon Redshift Serverless to route traffic through
	// your VPC.
	EnhancedVpcRouting *bool

	// The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve
	// queries. The max capacity is specified in RPUs.
	MaxCapacity *int32

	// The custom port to use when connecting to a workgroup. Valid port ranges are
	// 5431-5455 and 8191-8215. The default is 5439.
	Port *int32

	// A value that specifies whether the workgroup can be accessible from a public
	// network.
	PubliclyAccessible *bool

	// An array of security group IDs to associate with the workgroup.
	SecurityGroupIds []string

	// An array of VPC subnet IDs to associate with the workgroup.
	SubnetIds []string
	// contains filtered or unexported fields
}

type UpdateWorkgroupOutput

type UpdateWorkgroupOutput struct {

	// The updated workgroup object.
	//
	// This member is required.
	Workgroup *types.Workgroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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