Documentation

Overview

    Package redshiftdata provides the API client, operations, and parameter types for Redshift Data API Service.

    You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2019-12-20"
    View Source
    const ServiceID = "Redshift Data"

    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

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type CancelStatementInput

          type CancelStatementInput struct {
          
          	// The identifier of the SQL statement to cancel. This value is a universally
          	// unique identifier (UUID) generated by Amazon Redshift Data API. This identifier
          	// is returned by ExecuteStatment and ListStatements.
          	//
          	// This member is required.
          	Id *string
          }

          type CancelStatementOutput

          type CancelStatementOutput struct {
          
          	// A value that indicates whether the cancel statement succeeded (true).
          	Status *bool
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

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

            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) CancelStatement

                func (c *Client) CancelStatement(ctx context.Context, params *CancelStatementInput, optFns ...func(*Options)) (*CancelStatementOutput, error)

                  Cancels a running query. To be canceled, a query must be running.

                  func (*Client) DescribeStatement

                  func (c *Client) DescribeStatement(ctx context.Context, params *DescribeStatementInput, optFns ...func(*Options)) (*DescribeStatementOutput, error)

                    Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

                    func (*Client) DescribeTable

                    func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error)

                      Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

                      * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

                      * Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

                      func (*Client) ExecuteStatement

                      func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error)

                        Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

                        * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

                        * Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

                        func (*Client) GetStatementResult

                        func (c *Client) GetStatementResult(ctx context.Context, params *GetStatementResultInput, optFns ...func(*Options)) (*GetStatementResultOutput, error)

                          Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

                          func (*Client) ListDatabases

                          func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error)

                            List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

                            * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

                            * Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

                            func (*Client) ListSchemas

                            func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optFns ...func(*Options)) (*ListSchemasOutput, error)

                              Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

                              * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

                              * Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

                              func (*Client) ListStatements

                              func (c *Client) ListStatements(ctx context.Context, params *ListStatementsInput, optFns ...func(*Options)) (*ListStatementsOutput, error)

                                List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

                                func (*Client) ListTables

                                func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error)

                                  List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

                                  * AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret.

                                  * Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

                                  type DescribeStatementInput

                                  type DescribeStatementInput struct {
                                  
                                  	// The identifier of the SQL statement to describe. This value is a universally
                                  	// unique identifier (UUID) generated by Amazon Redshift Data API. This identifier
                                  	// is returned by ExecuteStatment and ListStatements.
                                  	//
                                  	// This member is required.
                                  	Id *string
                                  }

                                  type DescribeStatementOutput

                                  type DescribeStatementOutput struct {
                                  
                                  	// The identifier of the SQL statement described. This value is a universally
                                  	// unique identifier (UUID) generated by Amazon Redshift Data API.
                                  	//
                                  	// This member is required.
                                  	Id *string
                                  
                                  	// The cluster identifier.
                                  	ClusterIdentifier *string
                                  
                                  	// The date and time (UTC) when the SQL statement was submitted to run.
                                  	CreatedAt *time.Time
                                  
                                  	// The name of the database.
                                  	Database *string
                                  
                                  	// The database user name.
                                  	DbUser *string
                                  
                                  	// The amount of time in nanoseconds that the statement ran.
                                  	Duration int64
                                  
                                  	// The error message from the cluster if the SQL statement encountered an error
                                  	// while running.
                                  	Error *string
                                  
                                  	// The SQL statement text.
                                  	QueryString *string
                                  
                                  	// The process identifier from Amazon Redshift.
                                  	RedshiftPid int64
                                  
                                  	// The identifier of the query generated by Amazon Redshift. These identifiers are
                                  	// also available in the query column of the STL_QUERY system view.
                                  	RedshiftQueryId int64
                                  
                                  	// Either the number of rows returned from the SQL statement or the number of rows
                                  	// affected. If result size is greater than zero, the result rows can be the number
                                  	// of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and
                                  	// others.
                                  	ResultRows int64
                                  
                                  	// The size in bytes of the returned results.
                                  	ResultSize int64
                                  
                                  	// The name or Amazon Resource Name (ARN) of the secret that enables access to the
                                  	// database.
                                  	SecretArn *string
                                  
                                  	// The status of the SQL statement being described. Status values are defined as
                                  	// follows:
                                  	//
                                  	// * ABORTED - The query run was stopped by the user.
                                  	//
                                  	// * ALL - A status
                                  	// value that includes all query statuses. This value can be used to filter
                                  	// results.
                                  	//
                                  	// * FAILED - The query run failed.
                                  	//
                                  	// * FINISHED - The query has finished
                                  	// running.
                                  	//
                                  	// * PICKED - The query has been chosen to be run.
                                  	//
                                  	// * STARTED - The query
                                  	// run has started.
                                  	//
                                  	// * SUBMITTED - The query was submitted, but not yet processed.
                                  	Status types.StatusString
                                  
                                  	// The date and time (UTC) that the metadata for the SQL statement was last
                                  	// updated. An example is the time the status last changed.
                                  	UpdatedAt *time.Time
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type DescribeTableAPIClient

                                  type DescribeTableAPIClient interface {
                                  	DescribeTable(context.Context, *DescribeTableInput, ...func(*Options)) (*DescribeTableOutput, error)
                                  }

                                    DescribeTableAPIClient is a client that implements the DescribeTable operation.

                                    type DescribeTableInput

                                    type DescribeTableInput struct {
                                    
                                    	// The cluster identifier. This parameter is required when authenticating using
                                    	// either AWS Secrets Manager or temporary credentials.
                                    	//
                                    	// This member is required.
                                    	ClusterIdentifier *string
                                    
                                    	// The name of the database. This parameter is required when authenticating using
                                    	// temporary credentials.
                                    	Database *string
                                    
                                    	// The database user name. This parameter is required when authenticating using
                                    	// temporary credentials.
                                    	DbUser *string
                                    
                                    	// The maximum number of tables to return in the response. If more tables exist
                                    	// than fit in one response, then NextToken is returned to page through the
                                    	// results.
                                    	MaxResults int32
                                    
                                    	// A value that indicates the starting point for the next set of response records
                                    	// in a subsequent request. If a value is returned in a response, you can retrieve
                                    	// the next set of records by providing this returned NextToken value in the next
                                    	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                    	// all response records have been retrieved for the request.
                                    	NextToken *string
                                    
                                    	// The schema that contains the table. If no schema is specified, then matching
                                    	// tables for all schemas are returned.
                                    	Schema *string
                                    
                                    	// The name or ARN of the secret that enables access to the database. This
                                    	// parameter is required when authenticating using AWS Secrets Manager.
                                    	SecretArn *string
                                    
                                    	// The table name. If no table is specified, then all tables for all matching
                                    	// schemas are returned. If no table and no schema is specified, then all tables
                                    	// for all schemas in the database are returned
                                    	Table *string
                                    }

                                    type DescribeTableOutput

                                    type DescribeTableOutput struct {
                                    
                                    	// A list of columns in the table.
                                    	ColumnList []types.ColumnMetadata
                                    
                                    	// A value that indicates the starting point for the next set of response records
                                    	// in a subsequent request. If a value is returned in a response, you can retrieve
                                    	// the next set of records by providing this returned NextToken value in the next
                                    	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                    	// all response records have been retrieved for the request.
                                    	NextToken *string
                                    
                                    	// The table name.
                                    	TableName *string
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type DescribeTablePaginator

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

                                      DescribeTablePaginator is a paginator for DescribeTable

                                      func NewDescribeTablePaginator

                                      func NewDescribeTablePaginator(client DescribeTableAPIClient, params *DescribeTableInput, optFns ...func(*DescribeTablePaginatorOptions)) *DescribeTablePaginator

                                        NewDescribeTablePaginator returns a new DescribeTablePaginator

                                        func (*DescribeTablePaginator) HasMorePages

                                        func (p *DescribeTablePaginator) HasMorePages() bool

                                          HasMorePages returns a boolean indicating whether more pages are available

                                          func (*DescribeTablePaginator) NextPage

                                          func (p *DescribeTablePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTableOutput, error)

                                            NextPage retrieves the next DescribeTable page.

                                            type DescribeTablePaginatorOptions

                                            type DescribeTablePaginatorOptions struct {
                                            	// The maximum number of tables to return in the response. If more tables exist
                                            	// than fit in one response, then NextToken is returned to page through the
                                            	// 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
                                            }

                                              DescribeTablePaginatorOptions is the paginator options for DescribeTable

                                              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 ExecuteStatementInput

                                                      type ExecuteStatementInput struct {
                                                      
                                                      	// The cluster identifier. This parameter is required when authenticating using
                                                      	// either AWS Secrets Manager or temporary credentials.
                                                      	//
                                                      	// This member is required.
                                                      	ClusterIdentifier *string
                                                      
                                                      	// The SQL statement text to run.
                                                      	//
                                                      	// This member is required.
                                                      	Sql *string
                                                      
                                                      	// The name of the database. This parameter is required when authenticating using
                                                      	// temporary credentials.
                                                      	Database *string
                                                      
                                                      	// The database user name. This parameter is required when authenticating using
                                                      	// temporary credentials.
                                                      	DbUser *string
                                                      
                                                      	// The name or ARN of the secret that enables access to the database. This
                                                      	// parameter is required when authenticating using AWS Secrets Manager.
                                                      	SecretArn *string
                                                      
                                                      	// The name of the SQL statement. You can name the SQL statement when you create it
                                                      	// to identify the query.
                                                      	StatementName *string
                                                      
                                                      	// A value that indicates whether to send an event to the Amazon EventBridge event
                                                      	// bus after the SQL statement runs.
                                                      	WithEvent *bool
                                                      }

                                                      type ExecuteStatementOutput

                                                      type ExecuteStatementOutput struct {
                                                      
                                                      	// The cluster identifier.
                                                      	ClusterIdentifier *string
                                                      
                                                      	// The date and time (UTC) the statement was created.
                                                      	CreatedAt *time.Time
                                                      
                                                      	// The name of the database.
                                                      	Database *string
                                                      
                                                      	// The database user name.
                                                      	DbUser *string
                                                      
                                                      	// The identifier of the statement to be run. This value is a universally unique
                                                      	// identifier (UUID) generated by Amazon Redshift Data API.
                                                      	Id *string
                                                      
                                                      	// The name or ARN of the secret that enables access to the database.
                                                      	SecretArn *string
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type GetStatementResultAPIClient

                                                      type GetStatementResultAPIClient interface {
                                                      	GetStatementResult(context.Context, *GetStatementResultInput, ...func(*Options)) (*GetStatementResultOutput, error)
                                                      }

                                                        GetStatementResultAPIClient is a client that implements the GetStatementResult operation.

                                                        type GetStatementResultInput

                                                        type GetStatementResultInput struct {
                                                        
                                                        	// The identifier of the SQL statement whose results are to be fetched. This value
                                                        	// is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
                                                        	// This identifier is returned by ExecuteStatment and ListStatements.
                                                        	//
                                                        	// This member is required.
                                                        	Id *string
                                                        
                                                        	// A value that indicates the starting point for the next set of response records
                                                        	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                        	// the next set of records by providing this returned NextToken value in the next
                                                        	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                        	// all response records have been retrieved for the request.
                                                        	NextToken *string
                                                        }

                                                        type GetStatementResultOutput

                                                        type GetStatementResultOutput struct {
                                                        
                                                        	// The results of the SQL statement.
                                                        	//
                                                        	// This member is required.
                                                        	Records [][]types.Field
                                                        
                                                        	// The properties (metadata) of a column.
                                                        	ColumnMetadata []types.ColumnMetadata
                                                        
                                                        	// A value that indicates the starting point for the next set of response records
                                                        	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                        	// the next set of records by providing this returned NextToken value in the next
                                                        	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                        	// all response records have been retrieved for the request.
                                                        	NextToken *string
                                                        
                                                        	// The total number of rows in the result set returned from a query. You can use
                                                        	// this number to estimate the number of calls to the GetStatementResult operation
                                                        	// needed to page through the results.
                                                        	TotalNumRows int64
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type GetStatementResultPaginator

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

                                                          GetStatementResultPaginator is a paginator for GetStatementResult

                                                          func NewGetStatementResultPaginator

                                                          func NewGetStatementResultPaginator(client GetStatementResultAPIClient, params *GetStatementResultInput, optFns ...func(*GetStatementResultPaginatorOptions)) *GetStatementResultPaginator

                                                            NewGetStatementResultPaginator returns a new GetStatementResultPaginator

                                                            func (*GetStatementResultPaginator) HasMorePages

                                                            func (p *GetStatementResultPaginator) HasMorePages() bool

                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                              func (*GetStatementResultPaginator) NextPage

                                                              func (p *GetStatementResultPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetStatementResultOutput, error)

                                                                NextPage retrieves the next GetStatementResult page.

                                                                type GetStatementResultPaginatorOptions

                                                                type GetStatementResultPaginatorOptions struct {
                                                                	// 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
                                                                }

                                                                  GetStatementResultPaginatorOptions is the paginator options for GetStatementResult

                                                                  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 ListDatabasesAPIClient

                                                                  type ListDatabasesAPIClient interface {
                                                                  	ListDatabases(context.Context, *ListDatabasesInput, ...func(*Options)) (*ListDatabasesOutput, error)
                                                                  }

                                                                    ListDatabasesAPIClient is a client that implements the ListDatabases operation.

                                                                    type ListDatabasesInput

                                                                    type ListDatabasesInput struct {
                                                                    
                                                                    	// The cluster identifier. This parameter is required when authenticating using
                                                                    	// either AWS Secrets Manager or temporary credentials.
                                                                    	//
                                                                    	// This member is required.
                                                                    	ClusterIdentifier *string
                                                                    
                                                                    	// The name of the database. This parameter is required when authenticating using
                                                                    	// temporary credentials.
                                                                    	Database *string
                                                                    
                                                                    	// The database user name. This parameter is required when authenticating using
                                                                    	// temporary credentials.
                                                                    	DbUser *string
                                                                    
                                                                    	// The maximum number of databases to return in the response. If more databases
                                                                    	// exist than fit in one response, then NextToken is returned to page through the
                                                                    	// results.
                                                                    	MaxResults int32
                                                                    
                                                                    	// A value that indicates the starting point for the next set of response records
                                                                    	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                    	// the next set of records by providing this returned NextToken value in the next
                                                                    	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                    	// all response records have been retrieved for the request.
                                                                    	NextToken *string
                                                                    
                                                                    	// The name or ARN of the secret that enables access to the database. This
                                                                    	// parameter is required when authenticating using AWS Secrets Manager.
                                                                    	SecretArn *string
                                                                    }

                                                                    type ListDatabasesOutput

                                                                    type ListDatabasesOutput struct {
                                                                    
                                                                    	// The names of databases.
                                                                    	Databases []string
                                                                    
                                                                    	// A value that indicates the starting point for the next set of response records
                                                                    	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                    	// the next set of records by providing this returned NextToken value in the next
                                                                    	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                    	// all response records have been retrieved for the request.
                                                                    	NextToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type ListDatabasesPaginator

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

                                                                      ListDatabasesPaginator is a paginator for ListDatabases

                                                                      func NewListDatabasesPaginator

                                                                      func NewListDatabasesPaginator(client ListDatabasesAPIClient, params *ListDatabasesInput, optFns ...func(*ListDatabasesPaginatorOptions)) *ListDatabasesPaginator

                                                                        NewListDatabasesPaginator returns a new ListDatabasesPaginator

                                                                        func (*ListDatabasesPaginator) HasMorePages

                                                                        func (p *ListDatabasesPaginator) HasMorePages() bool

                                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                                          func (*ListDatabasesPaginator) NextPage

                                                                          func (p *ListDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatabasesOutput, error)

                                                                            NextPage retrieves the next ListDatabases page.

                                                                            type ListDatabasesPaginatorOptions

                                                                            type ListDatabasesPaginatorOptions struct {
                                                                            	// The maximum number of databases to return in the response. If more databases
                                                                            	// exist than fit in one response, then NextToken is returned to page through the
                                                                            	// 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
                                                                            }

                                                                              ListDatabasesPaginatorOptions is the paginator options for ListDatabases

                                                                              type ListSchemasAPIClient

                                                                              type ListSchemasAPIClient interface {
                                                                              	ListSchemas(context.Context, *ListSchemasInput, ...func(*Options)) (*ListSchemasOutput, error)
                                                                              }

                                                                                ListSchemasAPIClient is a client that implements the ListSchemas operation.

                                                                                type ListSchemasInput

                                                                                type ListSchemasInput struct {
                                                                                
                                                                                	// The cluster identifier. This parameter is required when authenticating using
                                                                                	// either AWS Secrets Manager or temporary credentials.
                                                                                	//
                                                                                	// This member is required.
                                                                                	ClusterIdentifier *string
                                                                                
                                                                                	// The name of the database. This parameter is required when authenticating using
                                                                                	// temporary credentials.
                                                                                	//
                                                                                	// This member is required.
                                                                                	Database *string
                                                                                
                                                                                	// The database user name. This parameter is required when authenticating using
                                                                                	// temporary credentials.
                                                                                	DbUser *string
                                                                                
                                                                                	// The maximum number of schemas to return in the response. If more schemas exist
                                                                                	// than fit in one response, then NextToken is returned to page through the
                                                                                	// results.
                                                                                	MaxResults int32
                                                                                
                                                                                	// A value that indicates the starting point for the next set of response records
                                                                                	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                	// the next set of records by providing this returned NextToken value in the next
                                                                                	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                	// all response records have been retrieved for the request.
                                                                                	NextToken *string
                                                                                
                                                                                	// A pattern to filter results by schema name. Within a schema pattern, "%" means
                                                                                	// match any substring of 0 or more characters and "_" means match any one
                                                                                	// character. Only schema name entries matching the search pattern are returned.
                                                                                	SchemaPattern *string
                                                                                
                                                                                	// The name or ARN of the secret that enables access to the database. This
                                                                                	// parameter is required when authenticating using AWS Secrets Manager.
                                                                                	SecretArn *string
                                                                                }

                                                                                type ListSchemasOutput

                                                                                type ListSchemasOutput struct {
                                                                                
                                                                                	// A value that indicates the starting point for the next set of response records
                                                                                	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                	// the next set of records by providing this returned NextToken value in the next
                                                                                	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                	// all response records have been retrieved for the request.
                                                                                	NextToken *string
                                                                                
                                                                                	// The schemas that match the request pattern.
                                                                                	Schemas []string
                                                                                
                                                                                	// Metadata pertaining to the operation's result.
                                                                                	ResultMetadata middleware.Metadata
                                                                                }

                                                                                type ListSchemasPaginator

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

                                                                                  ListSchemasPaginator is a paginator for ListSchemas

                                                                                  func NewListSchemasPaginator

                                                                                  func NewListSchemasPaginator(client ListSchemasAPIClient, params *ListSchemasInput, optFns ...func(*ListSchemasPaginatorOptions)) *ListSchemasPaginator

                                                                                    NewListSchemasPaginator returns a new ListSchemasPaginator

                                                                                    func (*ListSchemasPaginator) HasMorePages

                                                                                    func (p *ListSchemasPaginator) HasMorePages() bool

                                                                                      HasMorePages returns a boolean indicating whether more pages are available

                                                                                      func (*ListSchemasPaginator) NextPage

                                                                                      func (p *ListSchemasPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchemasOutput, error)

                                                                                        NextPage retrieves the next ListSchemas page.

                                                                                        type ListSchemasPaginatorOptions

                                                                                        type ListSchemasPaginatorOptions struct {
                                                                                        	// The maximum number of schemas to return in the response. If more schemas exist
                                                                                        	// than fit in one response, then NextToken is returned to page through the
                                                                                        	// 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
                                                                                        }

                                                                                          ListSchemasPaginatorOptions is the paginator options for ListSchemas

                                                                                          type ListStatementsAPIClient

                                                                                          type ListStatementsAPIClient interface {
                                                                                          	ListStatements(context.Context, *ListStatementsInput, ...func(*Options)) (*ListStatementsOutput, error)
                                                                                          }

                                                                                            ListStatementsAPIClient is a client that implements the ListStatements operation.

                                                                                            type ListStatementsInput

                                                                                            type ListStatementsInput struct {
                                                                                            
                                                                                            	// The maximum number of SQL statements to return in the response. If more SQL
                                                                                            	// statements exist than fit in one response, then NextToken is returned to page
                                                                                            	// through the results.
                                                                                            	MaxResults int32
                                                                                            
                                                                                            	// A value that indicates the starting point for the next set of response records
                                                                                            	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                            	// the next set of records by providing this returned NextToken value in the next
                                                                                            	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                            	// all response records have been retrieved for the request.
                                                                                            	NextToken *string
                                                                                            
                                                                                            	// The name of the SQL statement specified as input to ExecuteStatement to identify
                                                                                            	// the query. You can list multiple statements by providing a prefix that matches
                                                                                            	// the beginning of the statement name. For example, to list myStatement1,
                                                                                            	// myStatement2, myStatement3, and so on, then provide the a value of myStatement.
                                                                                            	// Data API does a case-sensitive match of SQL statement names to the prefix value
                                                                                            	// you provide.
                                                                                            	StatementName *string
                                                                                            
                                                                                            	// The status of the SQL statement to list. Status values are defined as
                                                                                            	// follows:
                                                                                            	//
                                                                                            	// * ABORTED - The query run was stopped by the user.
                                                                                            	//
                                                                                            	// * ALL - A status
                                                                                            	// value that includes all query statuses. This value can be used to filter
                                                                                            	// results.
                                                                                            	//
                                                                                            	// * FAILED - The query run failed.
                                                                                            	//
                                                                                            	// * FINISHED - The query has finished
                                                                                            	// running.
                                                                                            	//
                                                                                            	// * PICKED - The query has been chosen to be run.
                                                                                            	//
                                                                                            	// * STARTED - The query
                                                                                            	// run has started.
                                                                                            	//
                                                                                            	// * SUBMITTED - The query was submitted, but not yet processed.
                                                                                            	Status types.StatusString
                                                                                            }

                                                                                            type ListStatementsOutput

                                                                                            type ListStatementsOutput struct {
                                                                                            
                                                                                            	// The SQL statements.
                                                                                            	//
                                                                                            	// This member is required.
                                                                                            	Statements []types.StatementData
                                                                                            
                                                                                            	// A value that indicates the starting point for the next set of response records
                                                                                            	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                            	// the next set of records by providing this returned NextToken value in the next
                                                                                            	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                            	// all response records have been retrieved for the request.
                                                                                            	NextToken *string
                                                                                            
                                                                                            	// Metadata pertaining to the operation's result.
                                                                                            	ResultMetadata middleware.Metadata
                                                                                            }

                                                                                            type ListStatementsPaginator

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

                                                                                              ListStatementsPaginator is a paginator for ListStatements

                                                                                              func NewListStatementsPaginator

                                                                                              func NewListStatementsPaginator(client ListStatementsAPIClient, params *ListStatementsInput, optFns ...func(*ListStatementsPaginatorOptions)) *ListStatementsPaginator

                                                                                                NewListStatementsPaginator returns a new ListStatementsPaginator

                                                                                                func (*ListStatementsPaginator) HasMorePages

                                                                                                func (p *ListStatementsPaginator) HasMorePages() bool

                                                                                                  HasMorePages returns a boolean indicating whether more pages are available

                                                                                                  func (*ListStatementsPaginator) NextPage

                                                                                                  func (p *ListStatementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStatementsOutput, error)

                                                                                                    NextPage retrieves the next ListStatements page.

                                                                                                    type ListStatementsPaginatorOptions

                                                                                                    type ListStatementsPaginatorOptions struct {
                                                                                                    	// The maximum number of SQL statements to return in the response. If more SQL
                                                                                                    	// statements exist than fit in one response, then NextToken is returned to page
                                                                                                    	// through the 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
                                                                                                    }

                                                                                                      ListStatementsPaginatorOptions is the paginator options for ListStatements

                                                                                                      type ListTablesAPIClient

                                                                                                      type ListTablesAPIClient interface {
                                                                                                      	ListTables(context.Context, *ListTablesInput, ...func(*Options)) (*ListTablesOutput, error)
                                                                                                      }

                                                                                                        ListTablesAPIClient is a client that implements the ListTables operation.

                                                                                                        type ListTablesInput

                                                                                                        type ListTablesInput struct {
                                                                                                        
                                                                                                        	// The cluster identifier. This parameter is required when authenticating using
                                                                                                        	// either AWS Secrets Manager or temporary credentials.
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	ClusterIdentifier *string
                                                                                                        
                                                                                                        	// The name of the database. This parameter is required when authenticating using
                                                                                                        	// temporary credentials.
                                                                                                        	//
                                                                                                        	// This member is required.
                                                                                                        	Database *string
                                                                                                        
                                                                                                        	// The database user name. This parameter is required when authenticating using
                                                                                                        	// temporary credentials.
                                                                                                        	DbUser *string
                                                                                                        
                                                                                                        	// The maximum number of tables to return in the response. If more tables exist
                                                                                                        	// than fit in one response, then NextToken is returned to page through the
                                                                                                        	// results.
                                                                                                        	MaxResults int32
                                                                                                        
                                                                                                        	// A value that indicates the starting point for the next set of response records
                                                                                                        	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                                        	// the next set of records by providing this returned NextToken value in the next
                                                                                                        	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                                        	// all response records have been retrieved for the request.
                                                                                                        	NextToken *string
                                                                                                        
                                                                                                        	// A pattern to filter results by schema name. Within a schema pattern, "%" means
                                                                                                        	// match any substring of 0 or more characters and "_" means match any one
                                                                                                        	// character. Only schema name entries matching the search pattern are returned. If
                                                                                                        	// SchemaPattern is not specified, then all tables that match TablePattern are
                                                                                                        	// returned. If neither SchemaPattern or TablePattern are specified, then all
                                                                                                        	// tables are returned.
                                                                                                        	SchemaPattern *string
                                                                                                        
                                                                                                        	// The name or ARN of the secret that enables access to the database. This
                                                                                                        	// parameter is required when authenticating using AWS Secrets Manager.
                                                                                                        	SecretArn *string
                                                                                                        
                                                                                                        	// A pattern to filter results by table name. Within a table pattern, "%" means
                                                                                                        	// match any substring of 0 or more characters and "_" means match any one
                                                                                                        	// character. Only table name entries matching the search pattern are returned. If
                                                                                                        	// TablePattern is not specified, then all tables that match SchemaPatternare
                                                                                                        	// returned. If neither SchemaPattern or TablePattern are specified, then all
                                                                                                        	// tables are returned.
                                                                                                        	TablePattern *string
                                                                                                        }

                                                                                                        type ListTablesOutput

                                                                                                        type ListTablesOutput struct {
                                                                                                        
                                                                                                        	// A value that indicates the starting point for the next set of response records
                                                                                                        	// in a subsequent request. If a value is returned in a response, you can retrieve
                                                                                                        	// the next set of records by providing this returned NextToken value in the next
                                                                                                        	// NextToken parameter and retrying the command. If the NextToken field is empty,
                                                                                                        	// all response records have been retrieved for the request.
                                                                                                        	NextToken *string
                                                                                                        
                                                                                                        	// The tables that match the request pattern.
                                                                                                        	Tables []types.TableMember
                                                                                                        
                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                        }

                                                                                                        type ListTablesPaginator

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

                                                                                                          ListTablesPaginator is a paginator for ListTables

                                                                                                          func NewListTablesPaginator

                                                                                                          func NewListTablesPaginator(client ListTablesAPIClient, params *ListTablesInput, optFns ...func(*ListTablesPaginatorOptions)) *ListTablesPaginator

                                                                                                            NewListTablesPaginator returns a new ListTablesPaginator

                                                                                                            func (*ListTablesPaginator) HasMorePages

                                                                                                            func (p *ListTablesPaginator) HasMorePages() bool

                                                                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                                                                              func (*ListTablesPaginator) NextPage

                                                                                                              func (p *ListTablesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTablesOutput, error)

                                                                                                                NextPage retrieves the next ListTables page.

                                                                                                                type ListTablesPaginatorOptions

                                                                                                                type ListTablesPaginatorOptions struct {
                                                                                                                	// The maximum number of tables to return in the response. If more tables exist
                                                                                                                	// than fit in one response, then NextToken is returned to page through the
                                                                                                                	// 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
                                                                                                                }

                                                                                                                  ListTablesPaginatorOptions is the paginator options for ListTables

                                                                                                                  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
                                                                                                                  
                                                                                                                  	// 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 endpoint options to be used when attempting to resolve an endpoint.
                                                                                                                  	EndpointOptions EndpointResolverOptions
                                                                                                                  
                                                                                                                  	// The service endpoint resolver.
                                                                                                                  	EndpointResolver EndpointResolver
                                                                                                                  
                                                                                                                  	// 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
                                                                                                                  
                                                                                                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                                  	// failures. When nil the API client will use a default retryer.
                                                                                                                  	Retryer aws.Retryer
                                                                                                                  
                                                                                                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                                  	// implementation if nil.
                                                                                                                  	HTTPClient HTTPClient
                                                                                                                  }

                                                                                                                  func (Options) Copy

                                                                                                                  func (o Options) Copy() Options

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

                                                                                                                    type ResolveEndpoint

                                                                                                                    type ResolveEndpoint struct {
                                                                                                                    	Resolver EndpointResolver
                                                                                                                    	Options  EndpointResolverOptions
                                                                                                                    }

                                                                                                                    func (*ResolveEndpoint) HandleSerialize

                                                                                                                    func (*ResolveEndpoint) ID

                                                                                                                    func (*ResolveEndpoint) ID() string

                                                                                                                    Directories

                                                                                                                    Path Synopsis
                                                                                                                    internal