Module erlcloud_athena

Function Index

batch_get_named_query/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_BatchGetNamedQuery.html.
batch_get_named_query/2
batch_get_query_execution/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_BatchGetQueryExecution.html.
batch_get_query_execution/2
configure/2
configure/3
configure/4
configure/5
create_named_query/4 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_CreateNamedQuery.html.
create_named_query/5
create_named_query/6
delete_named_query/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_DeleteNamedQuery.html.
delete_named_query/2
get_named_query/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetNamedQuery.html.
get_named_query/2
get_query_execution/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetQueryExecution.html.
get_query_execution/2
get_query_results/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetQueryResults.html.
get_query_results/2
get_query_results/3
list_named_queries/0 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_ListNamedQueries.html.
list_named_queries/1
list_named_queries/2
list_query_executions/0 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_ListQueryExecutions.html.
list_query_executions/1
list_query_executions/2
new/2
new/3
new/4
new/5
start_query_execution/4 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_StartQueryExecution.html.
start_query_execution/5
start_query_execution/6
start_query_execution/7
stop_query_execution/1 Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_StopQueryExecution.html.
stop_query_execution/2

Function Details

batch_get_named_query/1

batch_get_named_query(NamedQueryIds::[binary()]) -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_BatchGetNamedQuery.html

batch_get_named_query/2

batch_get_named_query(NamedQueryIds::[binary()], Config::aws_config()) -> {ok, map()} | {error, any()}

batch_get_query_execution/1

batch_get_query_execution(QueryExecutionIds::[binary()]) -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_BatchGetQueryExecution.html

batch_get_query_execution/2

batch_get_query_execution(QueryExecutionIds::[binary()], Config::aws_config()) -> {ok, map()} | {error, any()}

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

configure/4

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok

configure/5

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> ok

create_named_query/4

create_named_query(ClientReqToken::binary(), Db::binary(), Name::binary(), Query::binary()) -> {ok, binary()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_CreateNamedQuery.html

erlcloud_athena:create_named_query( <<"some-client-request-token">>, <<"db-name">>, <<"query-name">>, <<"select * from some-tbl">>, <<"optional-query-description">> ).

create_named_query/5

create_named_query(ClientReqToken::binary(), Db::binary(), Name::binary(), Query::binary(), Config::aws_config() | binary()) -> {ok, binary()} | {error, any()}

create_named_query/6

create_named_query(ClientReqToken::binary(), Db::binary(), Name::binary(), Query::binary(), Description::binary() | undefined, Config::aws_config()) -> {ok, binary()} | {error, any()}

delete_named_query/1

delete_named_query(NamedQueryId::binary()) -> ok | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_DeleteNamedQuery.html

delete_named_query/2

delete_named_query(NamedQueryId::binary(), Config::aws_config()) -> ok | {error, any()}

get_named_query/1

get_named_query(NamedQueryId::binary()) -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetNamedQuery.html

get_named_query/2

get_named_query(NamedQueryId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

get_query_execution/1

get_query_execution(QueryExecutionId::binary()) -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetQueryExecution.html

get_query_execution/2

get_query_execution(QueryExecutionId::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

get_query_results/1

get_query_results(QueryExecutionId::binary()) -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_GetQueryResults.html

erlcloud_athena:get_query_results(<<"some-query-uuid">>, #{<<"MaxResults">> => 1, <<"NextToken">> => <<"some-token">>}).

get_query_results/2

get_query_results(QueryExecutionId::binary(), Config::map() | aws_config()) -> {ok, map()} | {error, any()}

get_query_results/3

get_query_results(QueryExecutionId::binary(), PaginationMap::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_named_queries/0

list_named_queries() -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_ListNamedQueries.html

erlcloud_athena:list_named_queries(#{<<"MaxResults">> => 1, <<"NextToken">> => <<"some-token">>}).

list_named_queries/1

list_named_queries(Config::map() | aws_config()) -> {ok, map()} | {error, any()}

list_named_queries/2

list_named_queries(PaginationMap::map(), Config::aws_config()) -> {ok, map} | {error, any()}

list_query_executions/0

list_query_executions() -> {ok, map()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_ListQueryExecutions.html

erlcloud_athena:list_query_executions(#{<<"MaxResults">> => 1, <<"NextToken">> => <<"some-token">>}).

list_query_executions/1

list_query_executions(Config::map() | aws_config()) -> {ok, map()} | {error, any()}

list_query_executions/2

list_query_executions(PaginationMap::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

new/4

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()

new/5

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> aws_config()

start_query_execution/4

start_query_execution(ClientReqToken::binary(), Db::binary(), Query::binary(), OutputLocation::binary()) -> {ok, binary()} | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_StartQueryExecution.html

erlcloud_athena:start_query_execution( <<"some-client-request-token">>, <<"db-name">>, <<"select * from some-tbl">>, <<"s3://some-bucket">>, <<"SSE_KMS">>, <<"some-kms-key-id">>}] ).

start_query_execution/5

start_query_execution(ClientReqToken::binary(), Db::binary(), Query::binary(), OutputLocation::binary(), Config::aws_config()) -> {ok, binary()} | {error, any()}

start_query_execution/6

start_query_execution(ClientReqToken::binary(), Db::binary(), Query::binary(), OutputLocation::binary(), EncryptionOption::binary() | undefined, KmsKey::binary() | undefined) -> {ok, binary()} | {error, any()}

start_query_execution/7

start_query_execution(ClientReqToken::binary(), Db::binary(), Query::binary(), OutputLocation::binary(), EncryptionOption::binary() | undefined, KmsKey::binary() | undefined, Config::aws_config()) -> {ok, binary()} | {error, any()}

stop_query_execution/1

stop_query_execution(QueryExecutionId::binary()) -> ok | {error, any()}

Athena API: http://docs.aws.amazon.com/athena/latest/APIReference/API_StopQueryExecution.html

stop_query_execution/2

stop_query_execution(QueryExecutionId::binary(), Config::aws_config()) -> ok | {error, any()}


Generated by EDoc