Class: Aws::MWAA::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MWAA::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_cli_token(params = {}) ⇒ Types::CreateCliTokenResponse
Creates a CLI token for the Airflow CLI.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#create_web_login_token(params = {}) ⇒ Types::CreateWebLoginTokenResponse
Creates a web login token for the Airflow Web UI.
-
#delete_environment(params = {}) ⇒ Struct
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#publish_metrics(params = {}) ⇒ Struct
**Internal only**.
-
#tag_resource(params = {}) ⇒ Struct
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#untag_resource(params = {}) ⇒ Struct
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
-
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-mwaa/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1441 1442 1443 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1441 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1444 1445 1446 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1444 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1419 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-mwaa' context[:gem_version] = '1.42.0' Seahorse::Client::Request.new(handlers, context) end |
#create_cli_token(params = {}) ⇒ Types::CreateCliTokenResponse
Creates a CLI token for the Airflow CLI. To learn more, see [Creating an Apache Airflow CLI token].
[1]: docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-cli.html
459 460 461 462 |
# File 'lib/aws-sdk-mwaa/client.rb', line 459 def create_cli_token(params = {}, = {}) req = build_request(:create_cli_token, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
783 784 785 786 |
# File 'lib/aws-sdk-mwaa/client.rb', line 783 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_web_login_token(params = {}) ⇒ Types::CreateWebLoginTokenResponse
Creates a web login token for the Airflow Web UI. To learn more, see [Creating an Apache Airflow web login token].
[1]: docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html
823 824 825 826 |
# File 'lib/aws-sdk-mwaa/client.rb', line 823 def create_web_login_token(params = {}, = {}) req = build_request(:create_web_login_token, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Struct
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
847 848 849 850 |
# File 'lib/aws-sdk-mwaa/client.rb', line 847 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
933 934 935 936 |
# File 'lib/aws-sdk-mwaa/client.rb', line 933 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
972 973 974 975 |
# File 'lib/aws-sdk-mwaa/client.rb', line 972 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, ‘“Environment”: “Staging”`.
1005 1006 1007 1008 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1005 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_metrics(params = {}) ⇒ Struct
**Internal only**. Publishes environment health metrics to Amazon CloudWatch.
1057 1058 1059 1060 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1057 def publish_metrics(params = {}, = {}) req = build_request(:publish_metrics, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
1094 1095 1096 1097 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1094 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, ‘“Environment”: “Staging”`.
1125 1126 1127 1128 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1125 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
1410 1411 1412 1413 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1410 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1434 1435 1436 |
# File 'lib/aws-sdk-mwaa/client.rb', line 1434 def waiter_names [] end |