Skip to content

Latest commit

 

History

History
598 lines (560 loc) · 29.9 KB

community.missing_collection.aws_batch_info_module.rst

File metadata and controls

598 lines (560 loc) · 29.9 KB

community.missing_collection.aws_batch_info

Get details about AWS Batch.

Version added: 0.0.2

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
compute_environment_arns
list
Default:
[]
list of compute environment names.
list of compute environment arns.

aliases: compute_environment_names
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
describe_compute_environments
boolean
    Choices:
  • no
  • yes
do you want to describe compute environments related to compute_environment_arns?
describe_job_definitions
boolean
    Choices:
  • no
  • yes
do you want to describe job definitations related to job_definition_arns and job_definition_status?
describe_job_queues
boolean
    Choices:
  • no
  • yes
do you want to describe job queues related to job_queues?
describe_jobs
boolean
    Choices:
  • no
  • yes
do you want to describe job related to job_ids?
ec2_url
string
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
job_definition_arns
list
list of names of batch job definitions.
list of arns of batch job definitions.

aliases: job_definition_names
job_definition_status
string
Default:
"ACTIVE"
job definition status to filter.
job_ids
list
list of job ids.
job_queue
string
name of batch queue.
arn of batch queue.

aliases: job_queue_arn
job_queues
list
Default:
[]
list of names of batch queue.
list of arn of batch queue.

aliases: job_queue_arns
job_status
string
    Choices:
  • SUBMITTED
  • PENDING
  • RUNNABLE
  • STARTING
  • RUNNING ←
  • SUCCEEDED
  • FAILED
job status to filter the results.
list_jobs
boolean
    Choices:
  • no
  • yes
do you want to list job related to job_queue?
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: "Returns a list of AWS Batch jobs."
  aws_batch_info:
    job_queue: 'test'
    job_status: 'RUNNING'
    list_jobs: true

- name: "Describes a list of AWS Batch jobs."
  aws_batch_info:
    job_ids: ['test']
    describe_jobs: true

- name: "Describes one or more of your job queues."
  aws_batch_info:
    job_queues: []
    describe_job_queues: true

- name: "Describes a list of job definitions"
  aws_batch_info:
    job_definition_names: ['test']
    job_definition_status: 'ACTIVE'
    describe_job_definitions: true

- name: "Describes one or more of your compute environments."
  aws_batch_info:
    compute_environment_names: ['test']
    describe_compute_environments: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
compute_environments
list
when `describe_compute_environments` and `compute_environment_arns` are defined and success
Describes one or more of your compute environments.

Sample:
[{'compute_environment_name': 'string', 'compute_environment_arn': 'string', 'ecs_cluster_arn': 'string', 'tags': {}, 'type': 'MANAGED', 'state': 'ENABLED', 'status': 'CREATING', 'status_reason': 'string', 'compute_resources': {}, 'service_role': 'string'}]
job_definitions
list
when `describe_job_definitions` and `job_definition_arns` and `job_definition_status` are defined and success
Describes a list of job definitions.

Sample:
[{'job_definition_name': 'string', 'job_definition_arn': 'string', 'revision': 123, 'status': 'string', 'type': 'string', 'parameters': {}, 'retry_strategy': {}, 'container_properties': {}, 'timeout': {}, 'node_properties': {}, 'tags': {}, 'propagate_tags': True, 'platform_capabilities': []}]
job_queues
list
when `describe_job_queues` and `job_queues` are defined and success
Describes one or more of your job queues.

Sample:
[{'job_queue_name': 'string', 'job_queue_arn': 'string', 'state': 'ENABLED', 'status': 'CREATING', 'status_reason': 'string', 'priority': 123, 'compute_environment_order': [], 'tags': {}}]
job_summary_list
list
when `list_jobs` and `job_queue` are defined and success
Returns a list of AWS Batch jobs.

Sample:
[{'job_arn': 'string', 'job_id': 'string', 'job_name': 'string', 'created_at': 123, 'status': 'SUBMITTED', 'status_reason': 'string', 'started_at': 123, 'stopped_at': 123, 'container': {}, 'array_properties': {}, 'node_properties': {}}]
jobs
list
when `describe_jobs` and `job_ids` are defined and success
Describes a list of AWS Batch jobs.

Sample:
[{'job_arn': 'string', 'job_name': 'string', 'job_id': 'string', 'job_queue': 'string', 'status': 'SUBMITTED', 'attempts': [], 'status_reason': 'string', 'created_at': 123, 'retry_strategy': {}, 'started_at': 123, 'stopped_at': 123, 'depends_on': [], 'job_definition': 'string', 'parameters': {}, 'container': {}, 'node_details': {}, 'node_properties': {}, 'array_properties': {}, 'timeout': {}, 'tags': {}, 'propagate_tags': True, 'platform_capabilities': []}]


Status

Authors