AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeClusterSnapshotsInput

import "github.com/aws/aws-sdk-go/service/redshift"

type DescribeClusterSnapshotsInput struct { ClusterExists *bool `type:"boolean"` ClusterIdentifier *string `type:"string"` EndTime *time.Time `type:"timestamp"` Marker *string `type:"string"` MaxRecords *int64 `type:"integer"` OwnerAccount *string `type:"string"` SnapshotIdentifier *string `type:"string"` SnapshotType *string `type:"string"` SortingEntities []*SnapshotSortingEntity `locationNameList:"SnapshotSortingEntity" type:"list"` StartTime *time.Time `type:"timestamp"` TagKeys []*string `locationNameList:"TagKey" type:"list"` TagValues []*string `locationNameList:"TagValue" type:"list"` }

ClusterExists

Type: *bool

A value that indicates whether to return snapshots only for an existing cluster. Table-level restore can be performed only using a snapshot of an existing cluster, that is, a cluster that has not been deleted. If ClusterExists is set to true, ClusterIdentifier is required.

ClusterIdentifier

Type: *string

The identifier of the cluster for which information about snapshots is requested.

EndTime

Type: *time.Time

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2012-07-16T18:00:00Z

Marker

Type: *string

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords

Type: *int64

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

OwnerAccount

Type: *string

The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

SnapshotIdentifier

Type: *string

The snapshot identifier of the snapshot about which to return information.

SnapshotType

Type: *string

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

SortingEntities

Describes a sorting entity

StartTime

Type: *time.Time

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2012-07-16T18:00:00Z

TagKeys

Type: []*string

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

TagValues

Type: []*string

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Method

GoString

func (s DescribeClusterSnapshotsInput) GoString() string

GoString returns the string representation

SetClusterExists

func (s *DescribeClusterSnapshotsInput) SetClusterExists(v bool) *DescribeClusterSnapshotsInput

SetClusterExists sets the ClusterExists field's value.

SetClusterIdentifier

func (s *DescribeClusterSnapshotsInput) SetClusterIdentifier(v string) *DescribeClusterSnapshotsInput

SetClusterIdentifier sets the ClusterIdentifier field's value.

SetEndTime

func (s *DescribeClusterSnapshotsInput) SetEndTime(v time.Time) *DescribeClusterSnapshotsInput

SetEndTime sets the EndTime field's value.

SetMarker

func (s *DescribeClusterSnapshotsInput) SetMarker(v string) *DescribeClusterSnapshotsInput

SetMarker sets the Marker field's value.

SetMaxRecords

func (s *DescribeClusterSnapshotsInput) SetMaxRecords(v int64) *DescribeClusterSnapshotsInput

SetMaxRecords sets the MaxRecords field's value.

SetOwnerAccount

func (s *DescribeClusterSnapshotsInput) SetOwnerAccount(v string) *DescribeClusterSnapshotsInput

SetOwnerAccount sets the OwnerAccount field's value.

SetSnapshotIdentifier

func (s *DescribeClusterSnapshotsInput) SetSnapshotIdentifier(v string) *DescribeClusterSnapshotsInput

SetSnapshotIdentifier sets the SnapshotIdentifier field's value.

SetSnapshotType

func (s *DescribeClusterSnapshotsInput) SetSnapshotType(v string) *DescribeClusterSnapshotsInput

SetSnapshotType sets the SnapshotType field's value.

SetSortingEntities

func (s *DescribeClusterSnapshotsInput) SetSortingEntities(v []*SnapshotSortingEntity) *DescribeClusterSnapshotsInput

SetSortingEntities sets the SortingEntities field's value.

SetStartTime

func (s *DescribeClusterSnapshotsInput) SetStartTime(v time.Time) *DescribeClusterSnapshotsInput

SetStartTime sets the StartTime field's value.

SetTagKeys

func (s *DescribeClusterSnapshotsInput) SetTagKeys(v []*string) *DescribeClusterSnapshotsInput

SetTagKeys sets the TagKeys field's value.

SetTagValues

func (s *DescribeClusterSnapshotsInput) SetTagValues(v []*string) *DescribeClusterSnapshotsInput

SetTagValues sets the TagValues field's value.

String

func (s DescribeClusterSnapshotsInput) String() string

String returns the string representation

Validate

func (s *DescribeClusterSnapshotsInput) Validate() error

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

On this page: