community / community.aws / 1.1.0 / module / aws_glue_job Manage an AWS Glue job | "added in version" 1.0.0 of community.aws" Authors: Rob White (@wimnat)community.aws.aws_glue_job (1.1.0) — module
Install with ansible-galaxy collection install community.aws:==1.1.0
collections: - name: community.aws version: 1.1.0
Manage an AWS Glue job. See U(https://aws.amazon.com/glue/) for details.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Create an AWS Glue job - community.aws.aws_glue_job: command_script_location: s3bucket/script.py name: my-glue-job role: my-iam-role state: present
# Delete an AWS Glue job - community.aws.aws_glue_job: name: my-glue-job state: absent
name: description: - The name you assign to this job definition. It must be unique in your account. required: true type: str role: description: - The name or ARN of the IAM role associated with this job. - Required when I(state=present). type: str state: choices: - present - absent description: - Create or delete the AWS Glue job. required: true type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str timeout: description: - The job timeout in minutes. type: int access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str connections: description: - A list of Glue connections used for this job. elements: str type: list description: description: - Description of the job being defined. type: str max_retries: description: - The maximum number of times to retry this job if it fails. type: int command_name: default: glueetl description: - The name of the job command. This must be 'glueetl'. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool default_arguments: description: - A dict of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. type: dict allocated_capacity: description: - The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. type: int max_concurrent_runs: description: - The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit. type: int command_script_location: description: - The S3 path to a script that executes a job. - Required when I(state=present). type: str debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
allocated_capacity: description: The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. returned: when state is present sample: 10 type: int command: contains: name: description: The name of the job command. returned: when state is present sample: glueetl type: str script_location: description: Specifies the S3 path to a script that executes a job. returned: when state is present sample: mybucket/myscript.py type: str description: The JobCommand that executes this job. returned: when state is present type: complex connections: description: The connections used for this job. returned: when state is present sample: '{ Connections: [ ''list'', ''of'', ''connections'' ] }' type: dict created_on: description: The time and date that this job definition was created. returned: when state is present sample: '2018-04-21T05:19:58.326000+00:00' type: str default_arguments: description: The default arguments for this job, specified as name-value pairs. returned: when state is present sample: '{ ''mykey1'': ''myvalue1'' }' type: dict description: description: Description of the job being defined. returned: when state is present sample: My first Glue job type: str execution_property: contains: max_concurrent_runs: description: The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit. returned: when state is present sample: 1 type: int description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. returned: always type: complex job_name: description: The name of the AWS Glue job. returned: always sample: my-glue-job type: str last_modified_on: description: The last point in time when this job definition was modified. returned: when state is present sample: '2018-04-21T05:19:58.326000+00:00' type: str max_retries: description: The maximum number of times to retry this job after a JobRun fails. returned: when state is present sample: 5 type: int name: description: The name assigned to this job definition. returned: when state is present sample: my-glue-job type: str role: description: The name or ARN of the IAM role associated with this job. returned: when state is present sample: my-iam-role type: str timeout: description: The job timeout in minutes. returned: when state is present sample: 300 type: int