Module erlcloud_glue

Function Index
Function Details

Function Index

configure/2
configure/3
configure/4
configure/5
create_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateCrawler.html.
create_crawler/2
create_database/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateDatabase.html.
create_database/2
create_database/3
create_job/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateJob.html.
create_job/2
create_table/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateTable.html.
create_table/3
create_table/4
delete_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteCrawler.html.
delete_crawler/2
delete_job/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteJob.html.
delete_job/2
delete_table/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteTable.html.
delete_table/3
delete_table/4
get_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawler.html.
get_crawler/2
get_crawler_metrics/0	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawlerMetrics.html `erlcloud_glue:get_crawler_metrics( [<<"crawler-name-1">>, <<"crawl}er-name-2">>], #{<<"MaxResults">> => 1, <<"NextToken">> => <<"some-token">>} ).`.
get_crawler_metrics/1
get_crawler_metrics/2
get_crawler_metrics/3
get_crawlers/0	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawlers.html.
get_crawlers/1
get_crawlers/2
get_job/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJob.html.
get_job/2
get_job_run/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobRun.html.
get_job_run/3
get_job_run/4
get_job_runs/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobRuns.html.
get_job_runs/2
get_job_runs/3
get_jobs/0	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobs.html.
get_jobs/1
get_jobs/2
get_table/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetTable.html.
get_table/3
get_table/4
get_tables/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetTables.html.
get_tables/2
get_tables/3
get_tables/4
new/2
new/3
new/4
new/5
reset_job_bookmark/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_ResetJobBookmark.html.
reset_job_bookmark/2
start_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartCrawler.html.
start_crawler/2
start_crawler_schedule/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartCrawlerSchedule.html.
start_crawler_schedule/2
start_job_run/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartJobRun.html.
start_job_run/2
start_job_run/5
stop_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StopCrawler.html.
stop_crawler/2
stop_crawler_schedule/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StopCrawlerSchedule.html.
stop_crawler_schedule/2
update_crawler/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateCrawler.html.
update_crawler/2
update_crawler_schedule/1	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateCrawlerSchedule.html.
update_crawler_schedule/2
update_crawler_schedule/3
update_job/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateJob.html.
update_job/3
update_table/2	Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateTable.html.
update_table/3
update_table/4

Function Details

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_crawler/1

create_crawler(CrawlerInput::map()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateCrawler.html

erlcloud_glue:create_crawler(#{&lt;&lt;"Classifiers"&gt;&gt;   =&gt; [],
                                 &lt;&lt;"Configuration"&gt;&gt; =&gt; &lt;&lt;"some-config"&gt;&gt;},
                                 &lt;&lt;"DatabaseName"&gt;&gt;  =&gt; &lt;&lt;"db-name"&gt;&gt;,
                                 &lt;&lt;"Name"&gt;&gt;          =&gt; &lt;&lt;"crawler-name"&gt;&gt;,
                                 ...
                                 &lt;&lt;"Targets"&gt;&gt;       =&gt; {}}).

create_crawler/2

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

create_database/1

create_database(DatabaseInput::map()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateDatabase.html

erlcloud_glue:create_database(#{&lt;&lt;"Description"&gt;&gt; =&gt; &lt;&lt;"some-desc"&gt;&gt;,
                                  &lt;&lt;"Name"&gt;&gt;        =&gt; &lt;&lt;"db-name"&gt;&gt;},
                                &lt;&lt;"catalog-id"&gt;&gt;).

create_database/2

create_database(DatabaseInput::map(), CatalogId::binary() | aws_config()) -> ok | {error, any()}

create_database/3

create_database(DatabaseInput::map(), CatalogId::binary() | undefined, Config::aws_config()) -> ok | {error, any()}

create_job/1

create_job(JobInput::map()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateJob.html

erlcloud_glue:create_job(#{&lt;&lt;"Name"&gt;&gt;        =&gt; &lt;&lt;"job-name"&gt;&gt;,
                             &lt;&lt;"Description"&gt;&gt; =&gt; &lt;&lt;"some-desc"&gt;&gt;,
                             &lt;&lt;"Connections"&gt;&gt; =&gt;
                                 #{&lt;&lt;"Connections"&gt;&gt; =&gt; [&lt;&lt;"conn1"&gt;&gt;]}
                             ...
                             &lt;&lt;"LogUri"&gt;&gt;      =&gt; &lt;&lt;"some-uri"&gt;&gt;}).

create_job/2

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

create_table/2

create_table(DbName::binary(), TableInput::map()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_CreateTable.html

erlcloud_glue:create_table(&lt;&lt;"db-name"&gt;&gt;,
                             #{&lt;&lt;"Description"&gt;&gt; =&gt; &lt;&lt;"some-desc"&gt;&gt;,
                               &lt;&lt;"Name"&gt;&gt;        =&gt; &lt;&lt;"tbl-name"&gt;&gt;,
                               ...
                               &lt;&lt;"TableType"&gt;&gt;   =&gt; &lt;&lt;"some-type"&gt;&gt;},
                             &lt;&lt;"catalog-id"&gt;&gt;).

create_table/3

create_table(DbName::binary(), TableInput::map(), CatalogId::binary() | aws_config()) -> ok | {error, any()}

create_table/4

create_table(DbName::binary(), TableInput::map(), CatalogId::binary() | undefined, Config::aws_config()) -> ok | {error, any()}

delete_crawler/1

delete_crawler(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteCrawler.html

delete_crawler/2

delete_crawler(CrawlerName::binary(), Config::aws_config()) -> ok | {error, any()}

delete_job/1

delete_job(JobName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteJob.html

delete_job/2

delete_job(JobName::binary(), Config::aws_config()) -> ok | {error, any()}

delete_table/2

delete_table(DbName::binary(), TableName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_DeleteTable.html

delete_table/3

delete_table(DbName::binary(), TableName::binary(), CatalogId::binary() | aws_config()) -> ok | {error, any()}

delete_table/4

delete_table(DbName::binary(), TableName::binary(), CatalogId::binary() | undefined, Config::aws_config()) -> ok | {error, any()}

get_crawler/1

get_crawler(CrawlerName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawler.html

get_crawler/2

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

get_crawler_metrics/0

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

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawlerMetrics.html erlcloud_glue:get_crawler_metrics( [<<"crawler-name-1">>, <<"crawl}er-name-2">>], #{<<"MaxResults">> => 1, <<"NextToken">> => <<"some-token">>} ).

get_crawler_metrics/1

get_crawler_metrics(NameList::list() | map() | aws_config()) -> {ok, map()} | {error, any()}

get_crawler_metrics/2

get_crawler_metrics(NameList::list() | map(), PaginationMap::map() | aws_config()) -> {ok, map()} | {error, any()}

get_crawler_metrics/3

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

get_crawlers/0

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

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetCrawlers.html

erlcloud_glue:get_crawlers(#{&lt;&lt;"MaxResults"&gt;&gt; =&gt; 1,
                               &lt;&lt;"NextToken"&gt;&gt;  =&gt; &lt;&lt;"some-token"&gt;&gt;}).

get_crawlers/1

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

get_crawlers/2

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

get_job/1

get_job(JobName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJob.html

get_job/2

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

get_job_run/2

get_job_run(JobName::binary(), RunId::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobRun.html

get_job_run/3

get_job_run(JobName::binary(), RunId::binary(), PredecessorsIncluded::boolean() | aws_config()) -> {ok, map()} | {error, any()}

get_job_run/4

get_job_run(JobName::binary(), RunId::binary(), PredecessorsIncluded::boolean(), Config::aws_config()) -> {ok, map()} | {error, any()}

get_job_runs/1

get_job_runs(JobName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobRuns.html

erlcloud_glue:get_job_runs(&lt;&lt;"job-name"&gt;&gt;,
                             #{&lt;&lt;"MaxResults"&gt;&gt; =&gt; 1,
                               &lt;&lt;"NextToken"&gt;&gt;  =&gt; &lt;&lt;"some-token"&gt;&gt;}).

get_job_runs/2

get_job_runs(JobName::binary(), PaginationMap::map() | aws_config()) -> {ok, map()} | {error, any()}

get_job_runs/3

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

get_jobs/0

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

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetJobs.html

erlcloud_glue:get_jobs(#{&lt;&lt;"MaxResults"&gt;&gt; =&gt; 1,
                           &lt;&lt;"NextToken"&gt;&gt;  =&gt; &lt;&lt;"some-token"&gt;&gt;}).

get_jobs/1

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

get_jobs/2

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

get_table/2

get_table(DbName::binary(), TableName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetTable.html

get_table/3

get_table(DbName::binary(), TableName::binary(), CatalogId::binary() | aws_config()) -> {ok, map()} | {error, any()}

get_table/4

get_table(DbName::binary(), TableName::binary(), CatalogId::binary() | undefined, Config::aws_config()) -> {ok, map()} | {error, any()}

get_tables/1

get_tables(DbName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_GetTables.html

erlcloud_glue:get_tables(&lt;&lt;"db-name"&gt;&gt;,
                           &lt;&lt;"catalog-id"&gt;&gt;,
                           #{&lt;&lt;"Expression"&gt;&gt; =&gt; &lt;&lt;"some-regex-pattern"&gt;&gt;,
                             &lt;&lt;"MaxResults"&gt;&gt; =&gt; 1,
                             &lt;&lt;"NextToken"&gt;&gt;  =&gt; &lt;&lt;"some-token"&gt;&gt;}).

get_tables/2

get_tables(DbName::binary(), CatalogId::binary() | map() | aws_config()) -> {ok, map()} | {error, any()}

get_tables/3

get_tables(DbName::binary(), CatalogId::binary() | map(), Options::map() | aws_config()) -> {ok, map()} | {error, any()}

get_tables/4

get_tables(DbName::binary(), CatalogId::binary() | undefined, Options::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()

reset_job_bookmark/1

reset_job_bookmark(JobName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_ResetJobBookmark.html

reset_job_bookmark/2

reset_job_bookmark(JobName::binary(), Config::aws_config()) -> ok | {error, any()}

start_crawler/1

start_crawler(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartCrawler.html

start_crawler/2

start_crawler(CrawlerName::binary(), Config::aws_config()) -> ok | {error, any()}

start_crawler_schedule/1

start_crawler_schedule(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartCrawlerSchedule.html

start_crawler_schedule/2

start_crawler_schedule(CrawlerName::binary(), Config::aws_config()) -> ok | {error, any()}

start_job_run/1

start_job_run(JobName::binary()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StartJobRun.html

erlcloud_glue:start_job_run(&lt;&lt;"job-name"&gt;&gt;,
                              &lt;&lt;"job-run-id"&gt;&gt;,
                              5,
                              #{&lt;&lt;"Key-1"&gt;&gt; =&gt; &lt;&lt;"Value-1"&gt;&gt;,
                                &lt;&lt;"Key-2"&gt;&gt; =&gt; &lt;&lt;"Value-2"&gt;&gt;},
                              AwsConfig).

start_job_run/2

start_job_run(JobName::binary(), JobRunId::binary() | integer() | map()) -> {ok, map()} | {error, any()}

start_job_run/5

start_job_run(JobName::binary(), JobRunId::binary() | undefined, AllocatedCapacity::integer() | undefined, Arguments::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

stop_crawler/1

stop_crawler(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StopCrawler.html

stop_crawler/2

stop_crawler(CrawlerName::binary(), Config::aws_config()) -> ok | {error, any()}

stop_crawler_schedule/1

stop_crawler_schedule(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_StopCrawlerSchedule.html

stop_crawler_schedule/2

stop_crawler_schedule(CrawlerName::binary(), Config::aws_config()) -> ok | {error, any()}

update_crawler/1

update_crawler(CrawlerInput::map()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateCrawler.html

erlcloud_glue:update_crawler(#{&lt;&lt;"Classifiers"&gt;&gt;   =&gt; [],
                                 &lt;&lt;"Configuration"&gt;&gt; =&gt; &lt;&lt;"some-config"&gt;&gt;},
                                 &lt;&lt;"DatabaseName"&gt;&gt;  =&gt; &lt;&lt;"db-name"&gt;&gt;,
                                 &lt;&lt;"Name"&gt;&gt;          =&gt; &lt;&lt;"crawler-name"&gt;&gt;,
                                 ...
                                 &lt;&lt;"Targets"&gt;&gt;       =&gt; {}}).

update_crawler/2

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

update_crawler_schedule/1

update_crawler_schedule(CrawlerName::binary()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateCrawlerSchedule.html

erlcloud_glue:update_crawler_schedule(&lt;&lt;"crawler-name-1"&gt;&gt;,
                                        &lt;&lt;"cron(15 12 * * ? *)"&gt;&gt;).

update_crawler_schedule/2

update_crawler_schedule(CrawlerName::binary(), Schedule::binary() | undefined) -> ok | {error, any()}

update_crawler_schedule/3

update_crawler_schedule(CrawlerName::binary(), Schedule::binary() | undefined, Config::aws_config()) -> ok | {error, any()}

update_job/2

update_job(JobName::binary(), JobInput::map()) -> {ok, map()} | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateJob.html

erlcloud_glue:update_job(&lt;&lt;"job-name"&gt;&gt;,
                           #{&lt;&lt;"AllocatedCapacity"&gt;&gt; =&gt; 5,
                             &lt;&lt;"Command"&gt;&gt; =&gt;
                                 #{&lt;&lt;"Name"&gt;&gt;           =&gt; &lt;&lt;"some-name"&gt;&gt;,
                                   &lt;&lt;"ScriptLocation"&gt;&gt; =&gt; &lt;&lt;"location"&gt;&gt;},
                             ...
                             &lt;&lt;"Role"&gt;&gt; =&gt; &lt;&lt;"some-role"&gt;&gt;}).

update_job/3

update_job(JobName::binary(), JobInput::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

update_table/2

update_table(DbName::binary(), TableInput::map()) -> ok | {error, any()}

Glue API: https://docs.aws.amazon.com/glue/latest/webapi/API_UpdateTable.html

erlcloud_glue:update_table(<<"db-name">>, #{<<"Description">> => <<"some-desc">>, <<"Name">> => <<"tbl-name">>, ... <<"TableType">> => <<"some-type">>}, <<"catalog-id">>). '

update_table/3

update_table(DbName::binary(), TableInput::map(), CatalogId::binary() | aws_config()) -> ok | {error, any()}

update_table/4

update_table(DbName::binary(), TableInput::map(), CatalogId::binary() | undefined, Config::aws_config()) -> ok | {error, any()}

Generated by EDoc