@datafire/amazonaws_mwaa
v5.0.0
Published
DataFire integration for AmazonMWAA
Downloads
6
Readme
@datafire/amazonaws_mwaa
Client library for AmazonMWAA
Installation and Usage
npm install --save @datafire/amazonaws_mwaa
let amazonaws_mwaa = require('@datafire/amazonaws_mwaa').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
Description
Actions
CreateCliToken
amazonaws_mwaa.CreateCliToken({
"Name": ""
}, context)
Input
- input
object
- Name required
string
- Name required
Output
- output CreateCliTokenResponse
ListEnvironments
amazonaws_mwaa.ListEnvironments({}, context)
Input
- input
object
- MaxResults
integer
- NextToken
string
- MaxResults
Output
- output ListEnvironmentsOutput
DeleteEnvironment
amazonaws_mwaa.DeleteEnvironment({
"Name": ""
}, context)
Input
- input
object
- Name required
string
- Name required
Output
- output DeleteEnvironmentOutput
GetEnvironment
amazonaws_mwaa.GetEnvironment({
"Name": ""
}, context)
Input
- input
object
- Name required
string
- Name required
Output
- output GetEnvironmentOutput
UpdateEnvironment
amazonaws_mwaa.UpdateEnvironment({
"Name": ""
}, context)
Input
- input
object
- Name required
string
- AirflowConfigurationOptions
object
: The Airflow Configuration Options to update of your Amazon MWAA environment. - AirflowVersion
string
: The Airflow Version to update of your Amazon MWAA environment. - DagS3Path
string
: The Dags folder S3 Path to update of your Amazon MWAA environment. - EnvironmentClass
string
: The Environment Class to update of your Amazon MWAA environment. - ExecutionRoleArn
string
: The Executio Role ARN to update of your Amazon MWAA environment. - LoggingConfiguration
object
: The Logging Configuration of your Amazon MWAA environment.- DagProcessingLogs ModuleLoggingConfigurationInput
- SchedulerLogs ModuleLoggingConfigurationInput
- TaskLogs ModuleLoggingConfigurationInput
- WebserverLogs ModuleLoggingConfigurationInput
- WorkerLogs ModuleLoggingConfigurationInput
- MaxWorkers
integer
: The Maximum Workers to update of your Amazon MWAA environment. - NetworkConfiguration
object
: Provide the security group and subnet IDs for the workers and scheduler.- SecurityGroupIds
- items SecurityGroupId
- SecurityGroupIds
- PluginsS3ObjectVersion
string
: The Plugins.zip S3 Object Version to update of your Amazon MWAA environment. - PluginsS3Path
string
: The Plugins.zip S3 Path to update of your Amazon MWAA environment. - RequirementsS3ObjectVersion
string
: The Requirements.txt S3 ObjectV ersion to update of your Amazon MWAA environment. - RequirementsS3Path
string
: The Requirements.txt S3 Path to update of your Amazon MWAA environment. - SourceBucketArn
string
: The S3 Source Bucket ARN to update of your Amazon MWAA environment. - WebserverAccessMode
string
(values: PRIVATE_ONLY, PUBLIC_ONLY): The Webserver Access Mode to update of your Amazon MWAA environment. - WeeklyMaintenanceWindowStart
string
: The Weekly Maintenance Window Start to update of your Amazon MWAA environment.
- Name required
Output
- output UpdateEnvironmentOutput
CreateEnvironment
amazonaws_mwaa.CreateEnvironment({
"Name": "",
"DagS3Path": "",
"ExecutionRoleArn": "",
"NetworkConfiguration": {},
"SourceBucketArn": ""
}, context)
Input
- input
object
- Name required
string
- AirflowConfigurationOptions
object
: The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration. - AirflowVersion
string
: The Apache Airflow version you want to use for your environment. - DagS3Path required
string
: The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA. - EnvironmentClass
string
: The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services. - ExecutionRoleArn required
string
: The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow. - KmsKey
string
: The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide. - LoggingConfiguration
object
: The Logging Configuration of your Amazon MWAA environment.- DagProcessingLogs ModuleLoggingConfigurationInput
- SchedulerLogs ModuleLoggingConfigurationInput
- TaskLogs ModuleLoggingConfigurationInput
- WebserverLogs ModuleLoggingConfigurationInput
- WorkerLogs ModuleLoggingConfigurationInput
- MaxWorkers
integer
: The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment. - NetworkConfiguration required
object
: Provide the security group and subnet IDs for the workers and scheduler.- SecurityGroupIds
- items SecurityGroupId
- SubnetIds
- items SubnetId
- SecurityGroupIds
- PluginsS3ObjectVersion
string
: The plugins.zip file version you want to use. - PluginsS3Path
string
: The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA. - RequirementsS3ObjectVersion
string
: The requirements.txt file version you want to use. - RequirementsS3Path
string
: The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA. - SourceBucketArn required
string
: The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname. - Tags
object
: The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources. - WebserverAccessMode
string
(values: PRIVATE_ONLY, PUBLIC_ONLY): The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment. - WeeklyMaintenanceWindowStart
string
: The day and time you want MWAA to start weekly maintenance updates on your environment.
- Name required
Output
- output CreateEnvironmentOutput
PublishMetrics
amazonaws_mwaa.PublishMetrics({
"EnvironmentName": "",
"MetricData": []
}, context)
Input
- input
object
- EnvironmentName required
string
- MetricData required
array
: Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metrica.- items MetricDatum
- EnvironmentName required
Output
- output PublishMetricsOutput
ListTagsForResource
amazonaws_mwaa.ListTagsForResource({
"ResourceArn": ""
}, context)
Input
- input
object
- ResourceArn required
string
- ResourceArn required
Output
- output ListTagsForResourceOutput
TagResource
amazonaws_mwaa.TagResource({
"ResourceArn": "",
"Tags": {}
}, context)
Input
- input
object
- ResourceArn required
string
- Tags required
object
: The tag resource tag of the MWAA environments.
- ResourceArn required
Output
- output TagResourceOutput
UntagResource
amazonaws_mwaa.UntagResource({
"ResourceArn": "",
"tagKeys": []
}, context)
Input
- input
object
- ResourceArn required
string
- tagKeys required
array
- ResourceArn required
Output
- output UntagResourceOutput
CreateWebLoginToken
amazonaws_mwaa.CreateWebLoginToken({
"Name": ""
}, context)
Input
- input
object
- Name required
string
- Name required
Output
- output CreateWebLoginTokenResponse
Definitions
AccessDeniedException
AirflowConfigurationOptions
- AirflowConfigurationOptions
object
AirflowVersion
- AirflowVersion
string
CloudWatchLogGroupArn
- CloudWatchLogGroupArn
string
ConfigKey
- ConfigKey
string
ConfigValue
- ConfigValue
string
CreateCliTokenRequest
- CreateCliTokenRequest
object
CreateCliTokenResponse
- CreateCliTokenResponse
object
- CliToken
- WebServerHostname
CreateEnvironmentInput
- CreateEnvironmentInput
object
: This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.- AirflowConfigurationOptions
- AirflowVersion
- DagS3Path required
- EnvironmentClass
- ExecutionRoleArn required
- KmsKey
- LoggingConfiguration
- DagProcessingLogs ModuleLoggingConfigurationInput
- SchedulerLogs ModuleLoggingConfigurationInput
- TaskLogs ModuleLoggingConfigurationInput
- WebserverLogs ModuleLoggingConfigurationInput
- WorkerLogs ModuleLoggingConfigurationInput
- MaxWorkers
- NetworkConfiguration required
- SecurityGroupIds
- items SecurityGroupId
- SubnetIds
- items SubnetId
- SecurityGroupIds
- PluginsS3ObjectVersion
- PluginsS3Path
- RequirementsS3ObjectVersion
- RequirementsS3Path
- SourceBucketArn required
- Tags
- WebserverAccessMode
- WeeklyMaintenanceWindowStart
CreateEnvironmentOutput
- CreateEnvironmentOutput
object
- Arn
CreateWebLoginTokenRequest
- CreateWebLoginTokenRequest
object
CreateWebLoginTokenResponse
- CreateWebLoginTokenResponse
object
- WebServerHostname
- WebToken
CreatedAt
- CreatedAt
string
DeleteEnvironmentInput
- DeleteEnvironmentInput
object
DeleteEnvironmentOutput
- DeleteEnvironmentOutput
object
Dimension
- Dimension
object
: Internal only API.- Name required
- Value required
Dimensions
- Dimensions
array
- items Dimension
Double
- Double
number
Environment
- Environment
object
: An Amazon MWAA environment.- AirflowConfigurationOptions
- AirflowVersion
- Arn
- CreatedAt
- DagS3Path
- EnvironmentClass
- ExecutionRoleArn
- KmsKey
- LastUpdate LastUpdate
- LoggingConfiguration
- DagProcessingLogs ModuleLoggingConfiguration
- SchedulerLogs ModuleLoggingConfiguration
- TaskLogs ModuleLoggingConfiguration
- WebserverLogs ModuleLoggingConfiguration
- WorkerLogs ModuleLoggingConfiguration
- MaxWorkers
- Name
- NetworkConfiguration NetworkConfiguration
- PluginsS3ObjectVersion
- PluginsS3Path
- RequirementsS3ObjectVersion
- RequirementsS3Path
- ServiceRoleArn
- SourceBucketArn
- Status
- Tags
- WebserverAccessMode
- WebserverUrl
- WeeklyMaintenanceWindowStart
EnvironmentArn
- EnvironmentArn
string
EnvironmentClass
- EnvironmentClass
string
EnvironmentList
- EnvironmentList
array
- items EnvironmentName
EnvironmentName
- EnvironmentName
string
EnvironmentStatus
- EnvironmentStatus
string
(values: CREATING, CREATE_FAILED, AVAILABLE, UPDATING, DELETING, DELETED)
ErrorCode
- ErrorCode
string
ErrorMessage
- ErrorMessage
string
GetEnvironmentInput
- GetEnvironmentInput
object
GetEnvironmentOutput
- GetEnvironmentOutput
object
- Environment
- AirflowConfigurationOptions
- AirflowVersion
- Arn
- CreatedAt
- DagS3Path
- EnvironmentClass
- ExecutionRoleArn
- KmsKey
- LastUpdate LastUpdate
- LoggingConfiguration
- DagProcessingLogs ModuleLoggingConfiguration
- SchedulerLogs ModuleLoggingConfiguration
- TaskLogs ModuleLoggingConfiguration
- WebserverLogs ModuleLoggingConfiguration
- WorkerLogs ModuleLoggingConfiguration
- MaxWorkers
- Name
- NetworkConfiguration NetworkConfiguration
- PluginsS3ObjectVersion
- PluginsS3Path
- RequirementsS3ObjectVersion
- RequirementsS3Path
- ServiceRoleArn
- SourceBucketArn
- Status
- Tags
- WebserverAccessMode
- WebserverUrl
- WeeklyMaintenanceWindowStart
- Environment
Hostname
- Hostname
string
IamRoleArn
- IamRoleArn
string
Integer
- Integer
integer
InternalServerException
KmsKey
- KmsKey
string
LastUpdate
- LastUpdate
object
: Last update information for the environment.- CreatedAt
- Error
- ErrorCode
- ErrorMessage
- Status
ListEnvironmentsInput
- ListEnvironmentsInput
object
ListEnvironmentsInputMaxResultsInteger
- ListEnvironmentsInputMaxResultsInteger
integer
ListEnvironmentsOutput
- ListEnvironmentsOutput
object
- Environments required
- items EnvironmentName
- NextToken
- Environments required
ListTagsForResourceInput
- ListTagsForResourceInput
object
ListTagsForResourceOutput
- ListTagsForResourceOutput
object
- Tags
LoggingConfiguration
- LoggingConfiguration
object
: The Logging Configuration of your Amazon MWAA environment.- DagProcessingLogs ModuleLoggingConfiguration
- SchedulerLogs ModuleLoggingConfiguration
- TaskLogs ModuleLoggingConfiguration
- WebserverLogs ModuleLoggingConfiguration
- WorkerLogs ModuleLoggingConfiguration
LoggingConfigurationInput
- LoggingConfigurationInput
object
: The Logging Configuration of your Amazon MWAA environment.- DagProcessingLogs ModuleLoggingConfigurationInput
- SchedulerLogs ModuleLoggingConfigurationInput
- TaskLogs ModuleLoggingConfigurationInput
- WebserverLogs ModuleLoggingConfigurationInput
- WorkerLogs ModuleLoggingConfigurationInput
LoggingEnabled
- LoggingEnabled
boolean
LoggingLevel
- LoggingLevel
string
(values: CRITICAL, ERROR, WARNING, INFO, DEBUG)
MaxWorkers
- MaxWorkers
integer
MetricData
- MetricData
array
- items MetricDatum
MetricDatum
- MetricDatum
object
: Internal only API.
ModuleLoggingConfiguration
- ModuleLoggingConfiguration
object
: A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.- CloudWatchLogGroupArn
- Enabled
- LogLevel
ModuleLoggingConfigurationInput
- ModuleLoggingConfigurationInput
object
: A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.- Enabled required
- LogLevel required
NetworkConfiguration
- NetworkConfiguration
object
: Provide the security group and subnet IDs for the workers and scheduler.- SecurityGroupIds
- items SecurityGroupId
- SubnetIds
- items SubnetId
- SecurityGroupIds
NextToken
- NextToken
string
PublishMetricsInput
- PublishMetricsInput
object
- MetricData required
- items MetricDatum
- MetricData required
PublishMetricsOutput
- PublishMetricsOutput
object
RelativePath
- RelativePath
string
ResourceNotFoundException
S3BucketArn
- S3BucketArn
string
S3ObjectVersion
- S3ObjectVersion
string
SecurityGroupId
- SecurityGroupId
string
SecurityGroupList
- SecurityGroupList
array
- items SecurityGroupId
StatisticSet
- StatisticSet
object
: Internal only API.- Maximum
- Minimum
- SampleCount
- Sum
String
- String
string
SubnetId
- SubnetId
string
SubnetList
- SubnetList
array
- items SubnetId
SyntheticCreateCliTokenResponseToken
- SyntheticCreateCliTokenResponseToken
string
SyntheticCreateEnvironmentInputAirflowConfigurationOptions
- SyntheticCreateEnvironmentInputAirflowConfigurationOptions
object
SyntheticCreateWebLoginTokenResponseToken
- SyntheticCreateWebLoginTokenResponseToken
string
SyntheticUpdateEnvironmentInputAirflowConfigurationOptions
- SyntheticUpdateEnvironmentInputAirflowConfigurationOptions
object
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagMap
- TagMap
object
TagResourceInput
- TagResourceInput
object
- Tags required
TagResourceOutput
- TagResourceOutput
object
TagValue
- TagValue
string
Timestamp
- Timestamp
string
Unit
- Unit
string
(values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None): Unit
UntagResourceInput
- UntagResourceInput
object
UntagResourceOutput
- UntagResourceOutput
object
UpdateCreatedAt
- UpdateCreatedAt
string
UpdateEnvironmentInput
- UpdateEnvironmentInput
object
- AirflowConfigurationOptions
- AirflowVersion
- DagS3Path
- EnvironmentClass
- ExecutionRoleArn
- LoggingConfiguration
- DagProcessingLogs ModuleLoggingConfigurationInput
- SchedulerLogs ModuleLoggingConfigurationInput
- TaskLogs ModuleLoggingConfigurationInput
- WebserverLogs ModuleLoggingConfigurationInput
- WorkerLogs ModuleLoggingConfigurationInput
- MaxWorkers
- NetworkConfiguration
- SecurityGroupIds required
- items SecurityGroupId
- SecurityGroupIds required
- PluginsS3ObjectVersion
- PluginsS3Path
- RequirementsS3ObjectVersion
- RequirementsS3Path
- SourceBucketArn
- WebserverAccessMode
- WeeklyMaintenanceWindowStart
UpdateEnvironmentOutput
- UpdateEnvironmentOutput
object
- Arn
UpdateError
- UpdateError
object
: Error information of update, if applicable.- ErrorCode
- ErrorMessage
UpdateNetworkConfigurationInput
- UpdateNetworkConfigurationInput
object
: Provide the security group and subnet IDs for the workers and scheduler.- SecurityGroupIds required
- items SecurityGroupId
- SecurityGroupIds required
UpdateStatus
- UpdateStatus
string
(values: SUCCESS, PENDING, FAILED)
ValidationException
WebserverAccessMode
- WebserverAccessMode
string
(values: PRIVATE_ONLY, PUBLIC_ONLY)
WebserverUrl
- WebserverUrl
string
WeeklyMaintenanceWindowStart
- WeeklyMaintenanceWindowStart
string