Skip to content

Latest commit

 

History

History
717 lines (673 loc) · 40.2 KB

community.missing_collection.aws_comprehend_info_module.rst

File metadata and controls

717 lines (673 loc) · 40.2 KB

community.missing_collection.aws_comprehend_info

Get Information about Amazon Comprehend.

Version added: 0.0.4

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
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.
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_status
string
    Choices:
  • SUBMITTED
  • IN_PROGRESS ←
  • COMPLETED
  • FAILED
  • STOP_REQUESTED
  • STOPPED
status of the job to filter results.
list_document_classification_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of document classification jobs for given job_status?
list_document_classifiers
boolean
    Choices:
  • no
  • yes
do you want to get list of document classifiers?
list_dominant_language_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of dominant language detection jobs for given job_status?
list_entities_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of entities detection jobs for given job_status?
list_entity_recognizers
boolean
    Choices:
  • no
  • yes
do you want to get list of entity recognizers?
list_events_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of events detection jobs for given job_status?
list_key_phrases_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of key phrases detection jobs for given job_status?
list_pii_entities_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of pii entities detection jobs for given job_status?
list_sentiment_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of sentiment detection jobs for given job_status?
list_topics_detection_jobs
boolean
    Choices:
  • no
  • yes
do you want to get list of topics detection jobs for given job_status?
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: "get list of comprehend endpoints"
  aws_comprehend_info:

- name: "get list of comprehend document classification jobs"
  aws_comprehend_info:
    list_document_classification_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend document classifiers"
  aws_comprehend_info:
    list_document_classifiers: true

- name: "get list of comprehend dominant language detection jobs"
  aws_comprehend_info:
    list_dominant_language_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend entities detection jobs"
  aws_comprehend_info:
    list_entities_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend entity recognizers"
  aws_comprehend_info:
    list_entity_recognizers: true

- name: "get list of comprehend events detection jobs"
  aws_comprehend_info:
    list_events_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend key phrases detection jobs"
  aws_comprehend_info:
    list_key_phrases_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend pii entities detection jobs"
  aws_comprehend_info:
    list_pii_entities_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend sentiment detection jobs"
  aws_comprehend_info:
    list_sentiment_detection_jobs: true
    job_status: "SUBMITTED"

- name: "get list of comprehend topic detection jobs"
  aws_comprehend_info:
    list_topics_detection_jobs: true
    job_status: "SUBMITTED"

Return Values

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

Key Returned Description
document_classification_jobs
list
when `list_document_classification_jobs` and `job_status` are defined and success
get list of document classification jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
document_classifiers
list
when `list_document_classifiers` is defined and success
get list of document classifiers.

Sample:
[{'document_classifier_arn': 'string', 'language_code': 'en', 'status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'training_start_time': 'datetime(2017', 7: None, '7)': None, 'training_end_time': 'datetime(2018', 8: None, '8)': None, 'input_data_config': {}, 'output_data_config': {}, 'classifierMetadata': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}, 'mode': 'MULTI_CLASS'}]
endpoints
list
when no argument are defined and success
lit of endpoints.

Sample:
[{'endpoint_arn': 'string', 'status': 'CREATING', 'message': 'string', 'model_arn': 'string', 'desired_inference_units': 1234, 'current_inference_units': 123, 'creation_time': 'datetime(2016', 6: None, '6)': None, 'last_modified_Time': 'datetime(2015', 1: None, '1)': None}]
entities_detection_jobs
list
when `list_entities_detection_jobs` and `job_status` are defined and success
get list of entities detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
entity_recognizers
list
when `list_entity_recognizers` is defined and success
get list of entity recognizers.

Sample:
[{'entity_recognizer_arn': 'string', 'language_code': 'en', 'status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'training_Start_time': 'datetime(2017', 7: None, '7)': None, 'training_end_time': 'datetime(2018', 8: None, '8)': None, 'input_data_config': {}, 'RecognizerMetadata': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
events_detection_jobs
list
when `list_events_detection_jobs` and `job_status` are defined and success
get list of event detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
key_phrases_detection_jobs
list
when `list_key_phrases_detection_jobs` and `job_status` are defined and success
get list of key phrases detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
language_detection_jobs
list
when `list_language_detection_jobs` and `job_status` are defined and success
get list of language detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
pii_entities_detection_jobs
list
when `list_pii_entities_detection_jobs` and `job_status` are defined and success
get list of pii entities detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
sentiment_detection_jobs
list
when `list_sentiment_detection_jobs` and `job_status` are defined and success
get list of sentiment detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]
topics_detection_jobs
list
when `list_topics_detection_jobs` and `job_status` are defined and success
get list of topics detection jobs.

Sample:
[{'job_id': 'string', 'job_name': 'string', 'job_status': 'SUBMITTED', 'message': 'string', 'submit_time': 'datetime(2016', 6: None, '6)': None, 'end_time': 'datetime(2015', 1: None, '1)': None, 'document_classifier_arn': 'string', 'input_data_config': {}, 'output_data_config': {}, 'data_access_role_arn': 'string', 'volume_kms_key_id': 'string', 'vpc_config': {}}]


Status

Authors