RedshiftDataAPIService

public struct RedshiftDataAPIService

Client object for interacting with AWS RedshiftDataAPIService 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.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the RedshiftDataAPIService client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    cancelStatement(_:)

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

Declaration

Swift

public func cancelStatement(_ input: CancelStatementRequest) -> EventLoopFuture<CancelStatementResponse>

describeStatement(_:)
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.
Declaration
Swift

public func describeStatement(_ input: DescribeStatementRequest) -> EventLoopFuture<DescribeStatementResponse>
describeTable(_:)
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.
Declaration
Swift

public func describeTable(_ input: DescribeTableRequest) -> EventLoopFuture<DescribeTableResponse>
executeStatement(_:)
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.
Declaration
Swift

public func executeStatement(_ input: ExecuteStatementInput) -> EventLoopFuture<ExecuteStatementOutput>
getStatementResult(_:)
Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
Declaration
Swift

public func getStatementResult(_ input: GetStatementResultRequest) -> EventLoopFuture<GetStatementResultResponse>
listDatabases(_:)
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.
Declaration
Swift

public func listDatabases(_ input: ListDatabasesRequest) -> EventLoopFuture<ListDatabasesResponse>
listSchemas(_:)
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.
Declaration
Swift

public func listSchemas(_ input: ListSchemasRequest) -> EventLoopFuture<ListSchemasResponse>
listStatements(_:)
List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
Declaration
Swift

public func listStatements(_ input: ListStatementsRequest) -> EventLoopFuture<ListStatementsResponse>
listTables(_:)
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.
Declaration
Swift

public func listTables(_ input: ListTablesRequest) -> EventLoopFuture<ListTablesResponse>

Paginators

describeTablePaginator(_:onPage:)
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.
Declaration
Swift

public func describeTablePaginator(_ input: DescribeTableRequest, onPage: @escaping (DescribeTableResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getStatementResultPaginator(_:onPage:)

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

Declaration

Swift

public func getStatementResultPaginator(_ input: GetStatementResultRequest, onPage: @escaping (GetStatementResultResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listDatabasesPaginator(_:onPage:)
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.
Declaration
Swift

public func listDatabasesPaginator(_ input: ListDatabasesRequest, onPage: @escaping (ListDatabasesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
listSchemasPaginator(_:onPage:)
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.
Declaration
Swift

public func listSchemasPaginator(_ input: ListSchemasRequest, onPage: @escaping (ListSchemasResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listStatementsPaginator(_:onPage:)

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

Declaration

Swift

public func listStatementsPaginator(_ input: ListStatementsRequest, onPage: @escaping (ListStatementsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

listTablesPaginator(_:onPage:)
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.
Declaration
Swift

public func listTablesPaginator(_ input: ListTablesRequest, onPage: @escaping (ListTablesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    DescribeTableRequest

Undocumented

Declaration

Swift

public struct DescribeTableRequest : AWSShape

extension RedshiftDataAPIService.DescribeTableRequest: AWSPaginateStringToken


                    
                    
                    GetStatementResultRequest

Undocumented

Declaration

Swift

public struct GetStatementResultRequest : AWSShape

extension RedshiftDataAPIService.GetStatementResultRequest: AWSPaginateStringToken


                    
                    
                    ListDatabasesRequest

Undocumented

Declaration

Swift

public struct ListDatabasesRequest : AWSShape

extension RedshiftDataAPIService.ListDatabasesRequest: AWSPaginateStringToken


                    
                    
                    ListSchemasRequest

Undocumented

Declaration

Swift

public struct ListSchemasRequest : AWSShape

extension RedshiftDataAPIService.ListSchemasRequest: AWSPaginateStringToken


                    
                    
                    ListStatementsRequest

Undocumented

Declaration

Swift

public struct ListStatementsRequest : AWSShape

extension RedshiftDataAPIService.ListStatementsRequest: AWSPaginateStringToken


                    
                    
                    ListTablesRequest

Undocumented

Declaration

Swift

public struct ListTablesRequest : AWSShape

extension RedshiftDataAPIService.ListTablesRequest: AWSPaginateStringToken

CancelStatementRequest
Undocumented
See more
Declaration
Swift

public struct CancelStatementRequest : AWSShape
CancelStatementResponse
Undocumented
See more
Declaration
Swift

public struct CancelStatementResponse : AWSShape
ColumnMetadata
Undocumented
See more
Declaration
Swift

public struct ColumnMetadata : AWSShape
DescribeStatementRequest
Undocumented
See more
Declaration
Swift

public struct DescribeStatementRequest : AWSShape
DescribeStatementResponse
Undocumented
See more
Declaration
Swift

public struct DescribeStatementResponse : AWSShape
DescribeTableResponse
Undocumented
See more
Declaration
Swift

public struct DescribeTableResponse : AWSShape
ExecuteStatementInput
Undocumented
See more
Declaration
Swift

public struct ExecuteStatementInput : AWSShape
ExecuteStatementOutput
Undocumented
See more
Declaration
Swift

public struct ExecuteStatementOutput : AWSShape
Field
Undocumented
See more
Declaration
Swift

public struct Field : AWSShape
GetStatementResultResponse
Undocumented
See more
Declaration
Swift

public struct GetStatementResultResponse : AWSShape
ListDatabasesResponse
Undocumented
See more
Declaration
Swift

public struct ListDatabasesResponse : AWSShape
ListSchemasResponse
Undocumented
See more
Declaration
Swift

public struct ListSchemasResponse : AWSShape
ListStatementsResponse
Undocumented
See more
Declaration
Swift

public struct ListStatementsResponse : AWSShape
ListTablesResponse
Undocumented
See more
Declaration
Swift

public struct ListTablesResponse : AWSShape
StatementData
Undocumented
See more
Declaration
Swift

public struct StatementData : AWSShape
TableMember
Undocumented
See more
Declaration
Swift

public struct TableMember : AWSShape

Enums


                    
                    
                    StatusString

Undocumented

Declaration

Swift

public enum StatusString : String, CustomStringConvertible, Codable