Class: Aws::MWAA::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MWAA::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb
Overview
An API client for MWAA. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MWAA::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_cli_token(params = {}) ⇒ Types::CreateCliTokenResponse
Create a CLI token to use Airflow CLI.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
JSON blob that describes the environment to create.
-
#create_web_login_token(params = {}) ⇒ Types::CreateWebLoginTokenResponse
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
-
#delete_environment(params = {}) ⇒ Struct
Delete an existing environment.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Get details of an existing environment.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
List Amazon MWAA Environments.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for MWAA environments.
-
#publish_metrics(params = {}) ⇒ Struct
An operation for publishing metrics from the customers to the Ops plane.
-
#tag_resource(params = {}) ⇒ Struct
Add tag to the MWAA environments.
-
#untag_resource(params = {}) ⇒ Struct
Remove a tag from the MWAA environments.
-
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Update an MWAA environment.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_cli_token(params = {}) ⇒ Types::CreateCliTokenResponse
Create a CLI token to use Airflow CLI.
355 356 357 358 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 355 def create_cli_token(params = {}, = {}) req = build_request(:create_cli_token, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
JSON blob that describes the environment to create.
551 552 553 554 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 551 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_web_login_token(params = {}) ⇒ Types::CreateWebLoginTokenResponse
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
582 583 584 585 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 582 def create_web_login_token(params = {}, = {}) req = build_request(:create_web_login_token, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Struct
Delete an existing environment.
604 605 606 607 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 604 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Get details of an existing environment.
677 678 679 680 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 677 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
List Amazon MWAA Environments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
714 715 716 717 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 714 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List the tags for MWAA environments.
743 744 745 746 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 743 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_metrics(params = {}) ⇒ Struct
An operation for publishing metrics from the customers to the Ops plane.
790 791 792 793 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 790 def publish_metrics(params = {}, = {}) req = build_request(:publish_metrics, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add tag to the MWAA environments.
818 819 820 821 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 818 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove a tag from the MWAA environments.
844 845 846 847 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 844 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Update an MWAA environment.
962 963 964 965 |
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 962 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |