W3cubDocs

/Ansible

ecs_service_facts - list or describe services in ecs

New in version 2.1.

Synopsis

  • Lists or describes services in ecs.

Requirements (on host that executes module)

  • boto
  • boto3
  • botocore
  • json
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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.
aliases: ec2_access_key, access_key
aws_secret_key
 no
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.
aliases: ec2_secret_key, secret_key
cluster
 no default
The cluster ARNS in which to list the services.
details
 no false
  • true
  • false
Set this to true if you want detailed information about the services.
ec2_url
 no
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.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
region
 no
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
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
service
 no
The service to get details for (required if details is true)
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Basic listing example
- ecs_service_facts:
    cluster: test-cluster
    service: console-test-service
    details: true

# Basic listing example
- ecs_service_facts:
    cluster: test-cluster

Return Values

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

name description returned type sample
services
When details is false, returns an array of service ARNs, otherwise an array of complex objects as described below.
 success complex
contains:
name description returned type sample
status
The valid values are ACTIVE, DRAINING, or INACTIVE.
 always string
pendingCount
The number of tasks in the cluster that are in the PENDING state.
 always int
loadBalancers
A list of load balancer objects
 always complex
desiredCount
The desired number of instantiations of the task definition to keep running on the service.
 always int
runningCount
The number of tasks in the cluster that are in the RUNNING state.
 always int
serviceName
A user-generated string used to identify the service
 always string
clusterArn
The Amazon Resource Name (ARN) of the of the cluster that hosts the service.
 always string
serviceArn
The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .
 always string
deployments
list of service deployments
 always list of complex
events
lost of service events
 always list of complex
taskDefinition
The ARN of a task definition to use for tasks in the service.
 always string

Notes

Note

  • for details of the parameters and returns see http://boto3.readthedocs.org/en/latest/reference/services/ecs.html
  • 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_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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ecs_service_facts_module.html