Skip to content

Latest commit

 

History

History
846 lines (795 loc) · 36.4 KB

community.missing_collection.aws_devicefarm_info_module.rst

File metadata and controls

846 lines (795 loc) · 36.4 KB

community.missing_collection.aws_devicefarm_info

(WIP) Get Information about AWS Device Farm.

Version added: 0.0.5

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
arn
string
can be arn of the run, job, suite, or test ARN?
can be arn of the project?
can be arn of the session?
artifact_type
string
    Choices:
  • SCREENSHOT
  • FILE ←
  • LOG
type of artifact.
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
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.
device_pool_type
string
    Choices:
  • CURATED ←
  • PRIVATE
type of device pool.
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
list_artifacts
boolean
    Choices:
  • no
  • yes
do you want to get list of artifacts of given arn?
list_device_instances
boolean
    Choices:
  • no
  • yes
do you want to get list device instances?
list_device_pools
boolean
    Choices:
  • no
  • yes
do you want to get list of device pools of given arn and device_pool_type?
list_devices
boolean
    Choices:
  • no
  • yes
do you want to get list of devices of given arn?
list_instance_profiles
boolean
    Choices:
  • no
  • yes
do you want to get list of instance profiles?
list_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of jobs of given arn?
list_network_profiles
boolean
    Choices:
  • no
  • yes
do you want to get list of network profiles of given arn and network_profile_type?
list_offering_promotions
boolean
    Choices:
  • no
  • yes
do you want to get list of offering promotions?
list_offering_transactions
boolean
    Choices:
  • no
  • yes
do you want to get list of offering transactions?
list_offerings
boolean
    Choices:
  • no
  • yes
do you want to get list of offerings?
list_remote_access_sessions
boolean
    Choices:
  • no
  • yes
do you want to get list of remote access sessions of given arn?
list_runs
boolean
    Choices:
  • no
  • yes
do you want to get list of runs of given arn?
list_samples
boolean
    Choices:
  • no
  • yes
do you want to get list of samples of given arn?
list_suites
boolean
    Choices:
  • no
  • yes
do you want to get list of suites of given arn?
list_test_grid_projects
boolean
    Choices:
  • no
  • yes
do you want to get list of test grid projects?
list_test_grid_session_actions
boolean
    Choices:
  • no
  • yes
do you want to get list of test grid session actions of given arn?
list_test_grid_session_artifacts
boolean
    Choices:
  • no
  • yes
do you want to get list of test grid session artifacts of given arn?
list_test_grid_sessions
boolean
    Choices:
  • no
  • yes
do you want to get list of test grid sessions of given arn and test_grid_session_status?
list_tests
boolean
    Choices:
  • no
  • yes
do you want to get list of tests of given arn?
list_uploads
boolean
    Choices:
  • no
  • yes
do you want to get list of uploads of given arn?
list_vpce_configurations
boolean
    Choices:
  • no
  • yes
do you want to get list of vpce configurations?
network_profile_type
string
    Choices:
  • CURATED ←
  • PRIVATE
type of network profile.
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
test_grid_session_status
string
    Choices:
  • ACTIVE ←
  • CLOSED
  • ERRORED
status of test grid session.
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: "Lists all the projects."
  aws_devicefarm_info:

- name: "Lists all of artifacts"
  aws_devicefarm_info:
    list_artifacts: true
    arn: 'test-arn'
    artifact_type: 'FILE'

- name: "Lists all of device instances"
  aws_devicefarm_info:
    list_device_instances: true

- name: "Lists all of device pools"
  aws_devicefarm_info:
    list_device_pools: true
    arn: 'test-arn'
    device_pool_type: 'CURATED'

- name: "Lists all of devices"
  aws_devicefarm_info:
    list_devices: true
    arn: 'test-arn'

- name: "Lists all of jobs"
  aws_devicefarm_info:
    list_jobs: true
    arn: 'test-arn'

- name: "Lists all of network profiles"
  aws_devicefarm_info:
    list_network_profiles: true
    arn: 'test-arn'
    network_profile_type: 'CURATED'

- name: "Lists all of offering promotions"
  aws_devicefarm_info:
    list_offering_promotions: true

- name: "Lists all of offering transactions"
  aws_devicefarm_info:
    list_offering_transactions: true

- name: "Lists all of offerings"
  aws_devicefarm_info:
    list_offerings: true

- name: "Lists all of remote access sessions"
  aws_devicefarm_info:
    list_remote_access_sessions: true
    arn: 'test-arn'

- name: "Lists all of runs"
  aws_devicefarm_info:
    list_runs: true
    arn: 'test-arn'

- name: "Lists all of samples"
  aws_devicefarm_info:
    list_samples: true
    arn: 'test-arn'

- name: "Lists all of suites"
  aws_devicefarm_info:
    list_suites: true
    arn: 'test-arn'

- name: "Lists all of test grid projects"
  aws_devicefarm_info:
    list_test_grid_projects: true

- name: "Lists all of test grid session actions"
  aws_devicefarm_info:
    list_test_grid_session_actions: true
    arn: 'test-session-arn'

- name: "Lists all of test grid session artifacts"
  aws_devicefarm_info:
    list_test_grid_session_artifacts: true
    arn: 'test-session-arn'

- name: "Lists all of test grid sessions"
  aws_devicefarm_info:
    list_test_grid_sessions: true
    arn: 'test-arn'
    test_grid_session_status: 'ACTIVE'

- name: "Lists all of tests"
  aws_devicefarm_info:
    list_tests: true
    arn: 'test-arn'

- name: "Lists all of uploads"
  aws_devicefarm_info:
    list_uploads: true
    arn: 'test-arn'

- name: "Lists all of vpce configurations"
  aws_devicefarm_info:
    list_vpce_configurations: true

Status

Authors