neulab/tldr huggingface dataset:
salt.modules.boto_kms.disable_key(key_id, region=None, key=None, keyid=None, profile=None) Mark key as disabled.
salt myminion boto_kms.disable_key 'alias/mykey'
salt.modules.boto_kms.disable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None) Disable key rotation for specified key.
salt myminion boto_kms.disable_key_rotation 'alias/mykey'
salt.modules.boto_kms.enable_key(key_id, region=None, key=None, keyid=None, profile=None) Mark key as enabled.
salt myminion boto_kms.enable_key 'alias/mykey'
salt.modules.boto_kms.enable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None) Disable key rotation for specified key.
salt myminion boto_kms.enable_key_rotation 'alias/mykey'
salt.modules.boto_kms.encrypt(key_id, plaintext, encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Encrypt plaintext into cipher text using specified key.
salt myminion boto_kms.encrypt 'alias/mykey' 'myplaindata' '{"aws:username":"myuser"}'
salt.modules.boto_kms.generate_data_key(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Generate a secure data key.
salt myminion boto_kms.generate_data_key 'alias/mykey' number_of_bytes=1024 key_spec=AES_128
salt.modules.boto_kms.generate_data_key_without_plaintext(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Generate a secure data key without a plaintext copy of the key.
salt myminion boto_kms.generate_data_key_without_plaintext 'alias/mykey' number_of_bytes=1024 key_spec=AES_128
salt.modules.boto_kms.generate_random(number_of_bytes=None, region=None, key=None, keyid=None, profile=None) Generate a random string.
salt myminion boto_kms.generate_random number_of_bytes=1024
salt.modules.boto_kms.get_key_policy(key_id, policy_name, region=None, key=None, keyid=None, profile=None) Get the policy for the specified key.
salt myminion boto_kms.get_key_policy 'alias/mykey' mypolicy
salt.modules.boto_kms.get_key_rotation_status(key_id, region=None, key=None, keyid=None, profile=None) Get status of whether or not key rotation is enabled for a key.
salt myminion boto_kms.get_key_rotation_status 'alias/mykey'
salt.modules.boto_kms.key_exists(key_id, region=None, key=None, keyid=None, profile=None) Check for the existence of a key.
salt myminion boto_kms.key_exists 'alias/mykey'
salt.modules.boto_kms.list_grants(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None) List grants for the specified key.
salt myminion boto_kms.list_grants 'alias/mykey'
salt.modules.boto_kms.list_key_policies(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None) List key_policies for the specified key.
salt myminion boto_kms.list_key_policies 'alias/mykey'
salt.modules.boto_kms.put_key_policy(key_id, policy_name, policy, region=None, key=None, keyid=None, profile=None) Attach a key policy to the specified key.
salt myminion boto_kms.put_key_policy 'alias/mykey' default '{"Statement":...}'
salt.modules.boto_kms.re_encrypt(ciphertext_blob, destination_key_id, source_encryption_context=None, destination_encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Reencrypt encrypted data with a new master key.
salt myminion boto_kms.re_encrypt 'encrypted_data' 'alias/mynewkey' default '{"Statement":...}'
salt.modules.boto_kms.revoke_grant(key_id, grant_id, region=None, key=None, keyid=None, profile=None) Revoke a grant from a key.
salt myminion boto_kms.revoke_grant 'alias/mykey' 8u89hf-j09j...
salt.modules.boto_kms.update_key_description(key_id, description, region=None, key=None, keyid=None, profile=None) Update a key's description.
salt myminion boto_kms.update_key_description 'alias/mykey' 'My key'
salt.modules.boto_lambda Connection module for Amazon Lambda
configuration This module accepts explicit Lambda credentials but can also utilize IAM roles assigned to the instance through Instance Profiles.  Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available here.
function: - {...} - {...}
salt.modules.boto_lambda.add_permission(FunctionName, StatementId, Action, Principal, SourceArn=None, SourceAccount=None, Qualifier=None, region=None, key=None, keyid=None, profile=None) Add a permission to a lambda function.
Returns {added: true} if the permission was added and returns {added: False} if the permission was not added.
salt myminion boto_lamba.add_permission my_function my_id "lambda:*" \ s3.amazonaws.com aws:arn::::bucket-name \ aws-account-id
salt.modules.boto_lambda.alias_exists(FunctionName, Name, region=None, key=None, keyid=None, profile=None) Given a function name and alias name, check to see if the given alias exists.
Returns True if the given alias exists and returns False if the given alias does not exist.
salt myminion boto_lambda.alias_exists myfunction myalias
salt.modules.boto_lambda.create_alias(FunctionName, Name, FunctionVersion, Description='', region=None, key=None, keyid=None, profile=None) Given a valid config, create an alias to a function.
Returns {created: true} if the alias was created and returns {created: False} if the alias was not created.
salt myminion boto_lamba.create_alias my_function my_alias $LATEST "An alias"
salt.modules.boto_lambda.create_event_source_mapping(EventSourceArn, FunctionName, StartingPosition, Enabled=True, BatchSize=100, region=None, key=None, keyid=None, profile=None) Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.
Returns {created: true} if the event source mapping was created and returns {created: False} if the event source mapping was not created.
salt myminion boto_lamba.create_event_source_mapping arn::::eventsource myfunction LATEST
salt.modules.boto_lambda.create_function(FunctionName, Runtime, Role, Handler, ZipFile=None, S3Bucket=None, S3Key=None, S3ObjectVersion=None, Description='', Timeout=3, MemorySize=128, Publish=False, WaitForRole=False, RoleRetries=5, region=None, key=None, keyid=None, profile=None, VpcConfig=None, Environment=None) New in version 2017.7.0.
Given a valid config, create a function.
Environment The parent object that contains your environment's configuration settings. This is a dictionary of the form:
{ 'Variables': { 'VariableName': 'VariableValue' } }
Returns {'created': True} if the function was created and {created: False} if the function was not created.
salt myminion boto_lamba.create_function my_function python2.7 my_role my_file.my_function my_function.zip salt myminion boto_lamba.create_function my_function python2.7 my_role my_file.my_function salt://files/my_function.zip
salt.modules.boto_lambda.delete_alias(FunctionName, Name, region=None, key=None, keyid=None, profile=None) Given a function name and alias name, delete the alias.
Returns {deleted: true} if the alias was deleted and returns {deleted: false} if the alias was not deleted.
salt myminion boto_lambda.delete_alias myfunction myalias
salt.modules.boto_lambda.delete_event_source_mapping(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None) Given an event source mapping ID or an event source ARN and FunctionName, delete the event source mapping
Returns {deleted: true} if the mapping was deleted and returns {deleted: false} if the mapping was not deleted.
salt myminion boto_lambda.delete_event_source_mapping 260c423d-e8b5-4443-8d6a-5e91b9ecd0fa
salt.modules.boto_lambda.delete_function(FunctionName, Qualifier=None, region=None, key=None, keyid=None, profile=None) Given a function name and optional version qualifier, delete it.
Returns {deleted: true} if the function was deleted and returns {deleted: false} if the function was not deleted.
salt myminion boto_lambda.delete_function myfunction
salt.modules.boto_lambda.describe_alias(FunctionName, Name, region=None, key=None, keyid=None, profile=None) Given a function name and alias name describe the properties of the alias.
salt myminion boto_lambda.describe_alias myalias
salt.modules.boto_lambda.describe_event_source_mapping(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None) Given an event source mapping ID or an event source ARN and FunctionName, obtain the current settings of that mapping.
salt myminion boto_lambda.describe_event_source_mapping uuid
salt.modules.boto_lambda.describe_function(FunctionName, region=None, key=None, keyid=None, profile=None) Given a function name describe its properties.
salt myminion boto_lambda.describe_function myfunction
salt.modules.boto_lambda.event_source_mapping_exists(UUID=None, EventSourceArn=None, FunctionName=None, region=None, key=None, keyid=None, profile=None) Given an event source mapping ID or an event source ARN and FunctionName, check whether the mapping exists.
salt.modules.boto_lambda.function_exists(FunctionName, region=None, key=None, keyid=None, profile=None) Given a function name, check to see if the given function name exists.
Returns True if the given function exists and returns False if the given function does not exist.
salt myminion boto_lambda.function_exists myfunction
salt.modules.boto_lambda.get_event_source_mapping_ids(EventSourceArn, FunctionName, region=None, key=None, keyid=None, profile=None) Given an event source and function name, return a list of mapping IDs
salt myminion boto_lambda.get_event_source_mapping_ids arn:::: myfunction
salt.modules.boto_lambda.get_permissions(FunctionName, Qualifier=None, region=None, key=None, keyid=None, profile=None) Get resource permissions for the given lambda function
Returns dictionary of permissions, by statement ID
salt myminion boto_lamba.get_permissions my_function
permissions: {...}
salt.modules.boto_lambda.list_function_versions(FunctionName, region=None, key=None, keyid=None, profile=None) List the versions available for the given function.
Returns list of function versions
versions: - {...} - {...}
salt.modules.boto_lambda.list_functions(region=None, key=None, keyid=None, profile=None) List all Lambda functions visible in the current scope.
salt myminion boto_lambda.list_functions
salt.modules.boto_lambda.remove_permission(FunctionName, StatementId, Qualifier=None, region=None, key=None, keyid=None, profile=None) Remove a permission from a lambda function.
Returns {removed: true} if the permission was removed and returns {removed: False} if the permission was not removed.
salt myminion boto_lamba.remove_permission my_function my_id
salt.modules.boto_lambda.update_alias(FunctionName, Name, FunctionVersion=None, Description=None, region=None, key=None, keyid=None, profile=None) Update the named alias to the configuration.
Returns {updated: true} if the alias was updated and returns {updated: False} if the alias was not updated.
salt myminion boto_lamba.update_alias my_lambda my_alias $LATEST
salt.modules.boto_lambda.update_event_source_mapping(UUID, FunctionName=None, Enabled=None, BatchSize=None, region=None, key=None, keyid=None, profile=None) Update the event source mapping identified by the UUID.
salt myminion boto_lamba.update_event_source_mapping uuid FunctionName=new_function
salt.modules.boto_lambda.update_function_code(FunctionName, ZipFile=None, S3Bucket=None, S3Key=None, S3ObjectVersion=None, Publish=False, region=None, key=None, keyid=None, profile=None) Upload the given code to the named lambda function.
Returns {updated: true} if the function was updated and returns {updated: False} if the function was not updated.
salt myminion boto_lamba.update_function_code my_function ZipFile=function.zip
salt.modules.boto_lambda.update_function_config(FunctionName, Role=None, Handler=None, Description=None, Timeout=None, MemorySize=None, region=None, key=None, keyid=None, profile=None, VpcConfig=None, WaitForRole=False, RoleRetries=5, Environment=None) New in version 2017.7.0.
Update the named lambda function to the configuration.
Returns {'updated': True} if the function was updated, and {'updated': False} if the function was not updated.
salt myminion boto_lamba.update_function_config my_function my_role my_file.my_function "my lambda function"
salt.modules.boto_rds Connection module for Amazon RDS
configuration This module accepts explicit rds credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at:
rds.keyid: GKTADJGHEIQSXMKKRBJ08H rds.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
rds.region: us-east-1
salt.modules.boto_rds.create(name, allocated_storage, db_instance_class, engine, master_username, master_user_password, db_name=None, db_security_groups=None, vpc_security_group_ids=None, vpc_security_groups=None, availability_zone=None, db_subnet_group_name=None, preferred_maintenance_window=None, db_parameter_group_name=None, backup_retention_period=None, preferred_backup_window=None, port=None, multi_az=None, engine_version=None, auto_minor_version_upgrade=None, license_model=None, iops=None, option_group_name=None, character_set_name=None, publicly_accessible=None, wait_status=None, tags=None, db_cluster_identifier=None, storage_type=None, tde_credential_arn=None, tde_credential_password=None, storage_encrypted=None, kms_key_id=None, domain=None, copy_tags_to_snapshot=None, monitoring_interval=None, monitoring_role_arn=None, domain_iam_role_name=None, region=None, promotion_tier=None, key=None, keyid=None, profile=None) Create an RDS Instance
CLI example to create an RDS Instance:
salt myminion boto_rds.create myrds 10 db.t2.micro MySQL sqlusr sqlpassw
salt.modules.boto_rds.create_option_group(name, engine_name, major_engine_version, option_group_description, tags=None, region=None, key=None, keyid=None, profile=None) Create an RDS option group
CLI example to create an RDS option group:
salt myminion boto_rds.create_option_group my-opt-group mysql 5.6                 "group description"
salt.modules.boto_rds.create_parameter_group(name, db_parameter_group_family, description, tags=None, region=None, key=None, keyid=None, profile=None) Create an RDS parameter group
CLI example to create an RDS parameter group:
salt myminion boto_rds.create_parameter_group my-param-group mysql5.6                 "group description"
salt.modules.boto_rds.create_read_replica(name, source_name, db_instance_class=None, availability_zone=None, port=None, auto_minor_version_upgrade=None, iops=None, option_group_name=None, publicly_accessible=None, tags=None, db_subnet_group_name=None, storage_type=None, copy_tags_to_snapshot=None, monitoring_interval=None, monitoring_role_arn=None, region=None, key=None, keyid=None, profile=None) Create an RDS read replica
CLI example to create an RDS  read replica:
salt myminion boto_rds.create_read_replica replicaname source_name
salt.modules.boto_rds.create_subnet_group(name, description, subnet_ids, tags=None, region=None, key=None, keyid=None, profile=None) Create an RDS subnet group
CLI example to create an RDS subnet group:
salt myminion boto_rds.create_subnet_group my-subnet-group             "group description" '[subnet-12345678, subnet-87654321]'             region=us-east-1
salt.modules.boto_rds.delete(name, skip_final_snapshot=None, final_db_snapshot_identifier=None, region=None, key=None, keyid=None, profile=None, tags=None, wait_for_deletion=True, timeout=180) Delete an RDS instance.
salt myminion boto_rds.delete myrds skip_final_snapshot=True                 region=us-east-1
salt.modules.boto_rds.delete_option_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS option group.
salt myminion boto_rds.delete_option_group my-opt-group                 region=us-east-1
salt.modules.boto_rds.delete_parameter_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS parameter group.
salt myminion boto_rds.delete_parameter_group my-param-group                 region=us-east-1
salt.modules.boto_rds.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS subnet group.
salt myminion boto_rds.delete_subnet_group my-subnet-group                 region=us-east-1
salt.modules.boto_rds.describe(name, tags=None, region=None, key=None, keyid=None, profile=None) Return RDS instance details.
salt myminion boto_rds.describe myrds
salt.modules.boto_rds.describe_db_instances(name=None, filters=None, jmespath='DBInstances', region=None, key=None, keyid=None, profile=None) Return a detailed listing of some, or all, DB Instances visible in the current scope.  Arbitrary subelements or subsections of the returned dataset can be selected by passing in a valid JMSEPath filter as well.
salt myminion boto_rds.describe_db_instances jmespath='DBInstances[*].DBInstanceIdentifier'
salt.modules.boto_rds.describe_db_subnet_groups(name=None, filters=None, jmespath='DBSubnetGroups', region=None, key=None, keyid=None, profile=None) Return a detailed listing of some, or all, DB Subnet Groups visible in the current scope.  Arbitrary subelements or subsections of the returned dataset can be selected by passing in a valid JMSEPath filter as well.
salt myminion boto_rds.describe_db_subnet_groups
salt.modules.boto_rds.describe_parameter_group(name, Filters=None, MaxRecords=None, Marker=None, region=None, key=None, keyid=None, profile=None) Returns a list of DBParameterGroup descriptions.  CLI example to description of parameter group:
salt myminion boto_rds.describe_parameter_group parametergroupname            region=us-east-1
salt.modules.boto_rds.describe_parameters(name, Source=None, MaxRecords=None, Marker=None, region=None, key=None, keyid=None, profile=None) Returns a list of DBParameterGroup parameters.  CLI example to description of parameters
salt myminion boto_rds.describe_parameters parametergroupname            region=us-east-1
salt.modules.boto_rds.exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS exists.
salt myminion boto_rds.exists myrds region=us-east-1
salt.modules.boto_rds.get_endpoint(name, tags=None, region=None, key=None, keyid=None, profile=None) Return the endpoint of an RDS instance.
salt myminion boto_rds.get_endpoint myrds
salt.modules.boto_rds.modify_db_instance(name, allocated_storage=None, allow_major_version_upgrade=None, apply_immediately=None, auto_minor_version_upgrade=None, backup_retention_period=None, ca_certificate_identifier=None, character_set_name=None, copy_tags_to_snapshot=None, db_cluster_identifier=None, db_instance_class=None, db_name=None, db_parameter_group_name=None, db_port_number=None, db_security_groups=None, db_subnet_group_name=None, domain=None, domain_iam_role_name=None, engine_version=None, iops=None, kms_key_id=None, license_model=None, master_user_password=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, new_db_instance_identifier=None, option_group_name=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, storage_encrypted=None, storage_type=None, tde_credential_arn=None, tde_credential_password=None, vpc_security_group_ids=None, region=None, key=None, keyid=None, profile=None) Modify settings for a DB instance.  CLI example to description of parameters
salt myminion boto_rds.modify_db_instance db_instance_identifier region=us-east-1
salt.modules.boto_rds.option_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS option group exists.
salt myminion boto_rds.option_group_exists myoptiongr region=us-east-1
salt.modules.boto_rds.parameter_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS parameter group exists.
salt myminion boto_rds.parameter_group_exists myparametergroup                 region=us-east-1
salt.modules.boto_rds.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS subnet group exists.
salt myminion boto_rds.subnet_group_exists my-param-group                 region=us-east-1
salt.modules.boto_rds.update_parameter_group(name, parameters, apply_method='pending-reboot', tags=None, region=None, key=None, keyid=None, profile=None) Update an RDS parameter group.
salt myminion boto_rds.update_parameter_group my-param-group                 parameters='{"back_log":1, "binlog_cache_size":4096}'                 region=us-east-1
salt.modules.boto_route53 Connection module for Amazon Route53
If a region is not specified, the default is 'universal', which is what the boto_route53 library expects, rather than None.
salt.modules.boto_route53.add_record(name, value, zone, record_type, identifier=None, ttl=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5) Add a record to a zone.
salt myminion boto_route53.add_record test.example.org 1.1.1.1 example.org A
retry_on_errors Continue to query if the zone exists after an error is raised. The previously used argument retry_on_rate_limit was deprecated for this argument. Users can still use retry_on_rate_limit to ensure backwards compatibility, but please migrate to using the favored retry_on_errors argument instead.
error_retries Number of times to attempt to query if the zone exists. The previously used argument rate_limit_retries was deprecated for this arguments. Users can still use rate_limit_retries to ensure backwards compatibility, but please migrate to using the favored error_retries argument instead.
salt.modules.boto_route53.create_healthcheck(ip_addr=None, fqdn=None, region=None, key=None, keyid=None, profile=None, port=53, hc_type='TCP', resource_path='', string_match=None, request_interval=30, failure_threshold=3, retry_on_errors=True, error_retries=5) Create a Route53 healthcheck
ip_addr IP address to check.  ip_addr or fqdn is required.
fqdn Domain name of the endpoint to check.  ip_addr or fqdn is required
port Port to check
hc_type Healthcheck type.  HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP
resource_path Path to check
string_match If hc_type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string to search for in the response body from the specified resource
request_interval The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
failure_threshold The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
region Region endpoint to connect to
key AWS key
keyid AWS keyid
profile AWS pillar profile
salt myminion boto_route53.create_healthcheck 192.168.0.1 salt myminion boto_route53.create_healthcheck 192.168.0.1 port=443 hc_type=HTTPS                                                       resource_path=/ fqdn=blog.saltstack.furniture
salt.modules.boto_route53.create_hosted_zone(domain_name, caller_ref=None, comment='', private_zone=False, vpc_id=None, vpc_name=None, vpc_region=None, region=None, key=None, keyid=None, profile=None) Create a new Route53 Hosted Zone. Returns a Python data structure with information about the newly created Hosted Zone.
domain_name The name of the domain. This must be fully-qualified, terminating with a period.  This is the name you have registered with your domain registrar.  It is also the name you will delegate from your registrar to the Amazon Route 53 delegation servers returned in response to this request.
caller_ref A unique string that identifies the request and that allows create_hosted_zone() calls to be retried without the risk of executing the operation twice.  It can take several minutes for the change to replicate globally, and change from PENDING to INSYNC status. Thus it's best to provide some value for this where possible, since duplicate calls while the first is in PENDING status will be accepted and can lead to multiple copies of the zone being created.  On the other hand, if a zone is created with a given caller_ref, then deleted, a second attempt to create a zone with the same caller_ref will fail until that caller_ref is flushed from the Route53 system, which can take upwards of 24 hours.
comment Any comments you want to include about the hosted zone.
private_zone Set True if creating a private hosted zone.
vpc_id When creating a private hosted zone, either the VPC ID or VPC Name to associate with is required.  Exclusive with vpe_name.  Ignored when creating a non-private zone.
vpc_name When creating a private hosted zone, either the VPC ID or VPC Name to associate with is required.  Exclusive with vpe_id.  Ignored when creating a non-private zone.
vpc_region When creating a private hosted zone, the region of the associated VPC is required.  If not provided, an effort will be made to determine it from vpc_id or vpc_name, where possible.  If this fails, you'll need to provide an explicit value for this option.  Ignored when creating a non-private zone.
salt myminion boto_route53.create_hosted_zone example.org
salt.modules.boto_route53.create_zone(zone, private=False, vpc_id=None, vpc_region=None, region=None, key=None, keyid=None, profile=None) Create a Route53 hosted zone.
zone   DNS zone to create
private True/False if the zone will be a private zone
vpc_id VPC ID to associate the zone to (required if private is True)
vpc_region VPC Region (required if private is True)
region region endpoint to connect to
key    AWS key
keyid  AWS keyid
salt myminion boto_route53.create_zone example.org
salt.modules.boto_route53.delete_record(name, zone, record_type, identifier=None, all_records=False, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5) Modify a record in a zone.
salt myminion boto_route53.delete_record test.example.org example.org A
salt.modules.boto_route53.delete_zone(zone, region=None, key=None, keyid=None, profile=None) Delete a Route53 hosted zone.
salt myminion boto_route53.delete_zone example.org
salt.modules.boto_route53.describe_hosted_zones(zone_id=None, domain_name=None, region=None, key=None, keyid=None, profile=None) Return detailed info about one, or all, zones in the bound account.  If neither zone_id nor domain_name is provided, return all zones.  Note that the return format is slightly different between the 'all' and 'single' description types.
zone_id The unique identifier for the Hosted Zone
domain_name The FQDN of the Hosted Zone (including final period)
profile A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.
salt myminion boto_route53.describe_hosted_zones domain_name=foo.bar.com.                 profile='{"region": "us-east-1", "keyid": "A12345678AB", "key": "xblahblahblah"}'
salt.modules.boto_route53.get_record(name, zone, record_type, fetch_all=False, region=None, key=None, keyid=None, profile=None, split_dns=False, private_zone=False, identifier=None, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5) Get a record from a zone.
salt myminion boto_route53.get_record test.example.org example.org A
salt.modules.boto_route53.list_all_zones_by_id(region=None, key=None, keyid=None, profile=None) List, by their IDs, all hosted zones in the bound account.
salt myminion boto_route53.list_all_zones_by_id
salt.modules.boto_route53.list_all_zones_by_name(region=None, key=None, keyid=None, profile=None) List, by their FQDNs, all hosted zones in the bound account.
salt myminion boto_route53.list_all_zones_by_name
salt.modules.boto_route53.update_record(name, value, zone, record_type, identifier=None, ttl=None, region=None, key=None, keyid=None, profile=None, wait_for_sync=True, split_dns=False, private_zone=False, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5) Modify a record in a zone.
salt myminion boto_route53.modify_record test.example.org 1.1.1.1 example.org A
salt.modules.boto_route53.zone_exists(zone, region=None, key=None, keyid=None, profile=None, retry_on_rate_limit=None, rate_limit_retries=None, retry_on_errors=True, error_retries=5) Check for the existence of a Route53 hosted zone.
salt myminion boto_route53.zone_exists example.org
salt.modules.boto_s3 Connection module for Amazon S3 using boto3
s3.region: us-east-1
salt.modules.boto_s3.get_object_metadata(name, extra_args=None, region=None, key=None, keyid=None, profile=None) Get metadata about an S3 object.  Returns None if the object does not exist.
You can pass AWS SSE-C related args and/or RequestPayer in extra_args.
salt myminion boto_s3.get_object_metadata \ my_bucket/path/to/object \ region=us-east-1 \ key=key \ keyid=keyid \ profile=profile \
salt.modules.boto_s3.upload_file(source, name, extra_args=None, region=None, key=None, keyid=None, profile=None) Upload a local file as an S3 object.
salt myminion boto_s3.upload_file \ /path/to/local/file \ my_bucket/path/to/object \ region=us-east-1 \ key=key \ keyid=keyid \ profile=profile \
salt.modules.boto_s3_bucket Connection module for Amazon S3 Buckets
salt.modules.boto_s3_bucket.create(Bucket, ACL=None, LocationConstraint=None, GrantFullControl=None, GrantRead=None, GrantReadACP=None, GrantWrite=None, GrantWriteACP=None, region=None, key=None, keyid=None, profile=None) Given a valid config, create an S3 Bucket.
Returns {created: true} if the bucket was created and returns {created: False} if the bucket was not created.
salt myminion boto_s3_bucket.create my_bucket \ GrantFullControl='emailaddress=example@example.com' \ GrantRead='uri="http://acs.amazonaws.com/groups/global/AllUsers"' \ GrantReadACP='emailaddress="exampl@example.com",id="2345678909876432"' \ LocationConstraint=us-west-1
salt.modules.boto_s3_bucket.delete(Bucket, MFA=None, RequestPayer=None, Force=False, region=None, key=None, keyid=None, profile=None) Given a bucket name, delete it, optionally emptying it first.
Returns {deleted: true} if the bucket was deleted and returns {deleted: false} if the bucket was not deleted.
salt myminion boto_s3_bucket.delete mybucket
salt.modules.boto_s3_bucket.delete_cors(Bucket, region=None, key=None, keyid=None, profile=None) Delete the CORS configuration for the given bucket
Returns {deleted: true} if CORS was deleted and returns {deleted: False} if CORS was not deleted.
salt myminion boto_s3_bucket.delete_cors my_bucket
salt.modules.boto_s3_bucket.delete_lifecycle_configuration(Bucket, region=None, key=None, keyid=None, profile=None) Delete the lifecycle configuration for the given bucket
Returns {deleted: true} if Lifecycle was deleted and returns {deleted: False} if Lifecycle was not deleted.
salt myminion boto_s3_bucket.delete_lifecycle_configuration my_bucket
salt.modules.boto_s3_bucket.delete_objects(Bucket, Delete, MFA=None, RequestPayer=None, region=None, key=None, keyid=None, profile=None) Delete objects in a given S3 bucket.
Returns {deleted: true} if all objects were deleted and {deleted: false, failed: [key, ...]} otherwise
salt myminion boto_s3_bucket.delete_objects mybucket '{Objects: [Key: myobject]}'
salt.modules.boto_s3_bucket.delete_policy(Bucket, region=None, key=None, keyid=None, profile=None) Delete the policy from the given bucket
Returns {deleted: true} if policy was deleted and returns {deleted: False} if policy was not deleted.
salt myminion boto_s3_bucket.delete_policy my_bucket
salt.modules.boto_s3_bucket.delete_replication(Bucket, region=None, key=None, keyid=None, profile=None) Delete the replication config from the given bucket
Returns {deleted: true} if replication configuration was deleted and returns {deleted: False} if replication configuration was not deleted.
salt myminion boto_s3_bucket.delete_replication my_bucket
salt.modules.boto_s3_bucket.delete_tagging(Bucket, region=None, key=None, keyid=None, profile=None) Delete the tags from the given bucket
Returns {deleted: true} if tags were deleted and returns {deleted: False} if tags were not deleted.
salt myminion boto_s3_bucket.delete_tagging my_bucket
salt.modules.boto_s3_bucket.delete_website(Bucket, region=None, key=None, keyid=None, profile=None) Remove the website configuration from the given bucket
Returns {deleted: true} if website configuration was deleted and returns {deleted: False} if website configuration was not deleted.
salt myminion boto_s3_bucket.delete_website my_bucket
salt.modules.boto_s3_bucket.describe(Bucket, region=None, key=None, keyid=None, profile=None) Given a bucket name describe its properties.
salt myminion boto_s3_bucket.describe mybucket
salt.modules.boto_s3_bucket.empty(Bucket, MFA=None, RequestPayer=None, region=None, key=None, keyid=None, profile=None) Delete all objects in a given S3 bucket.
salt myminion boto_s3_bucket.empty mybucket
salt.modules.boto_s3_bucket.exists(Bucket, region=None, key=None, keyid=None, profile=None) Given a bucket name, check to see if the given bucket exists.
Returns True if the given bucket exists and returns False if the given bucket does not exist.
salt myminion boto_s3_bucket.exists mybucket
salt.modules.boto_s3_bucket.list(region=None, key=None, keyid=None, profile=None) List all buckets owned by the authenticated sender of the request.
Returns list of buckets
Owner: {...} Buckets: - {...} - {...}
salt.modules.boto_s3_bucket.list_object_versions(Bucket, Delimiter=None, EncodingType=None, Prefix=None, region=None, key=None, keyid=None, profile=None) List objects in a given S3 bucket.
Returns a list of objects.
salt myminion boto_s3_bucket.list_object_versions mybucket
salt.modules.boto_s3_bucket.list_objects(Bucket, Delimiter=None, EncodingType=None, Prefix=None, FetchOwner=False, StartAfter=None, region=None, key=None, keyid=None, profile=None) List objects in a given S3 bucket.
salt myminion boto_s3_bucket.list_objects mybucket
salt.modules.boto_s3_bucket.put_acl(Bucket, ACL=None, AccessControlPolicy=None, GrantFullControl=None, GrantRead=None, GrantReadACP=None, GrantWrite=None, GrantWriteACP=None, region=None, key=None, keyid=None, profile=None) Given a valid config, update the ACL for a bucket.
Returns {updated: true} if the ACL was updated and returns {updated: False} if the ACL was not updated.
salt myminion boto_s3_bucket.put_acl my_bucket 'public' \ GrantFullControl='emailaddress=example@example.com' \ GrantRead='uri="http://acs.amazonaws.com/groups/global/AllUsers"' \ GrantReadACP='emailaddress="exampl@example.com",id="2345678909876432"'
salt.modules.boto_s3_bucket.put_cors(Bucket, CORSRules, region=None, key=None, keyid=None, profile=None) Given a valid config, update the CORS rules for a bucket.
Returns {updated: true} if CORS was updated and returns {updated: False} if CORS was not updated.
salt myminion boto_s3_bucket.put_cors my_bucket '[{\ "AllowedHeaders":[],\ "AllowedMethods":["GET"],\ "AllowedOrigins":["*"],\ "ExposeHeaders":[],\ "MaxAgeSeconds":123,\ }]'
salt.modules.boto_s3_bucket.put_lifecycle_configuration(Bucket, Rules, region=None, key=None, keyid=None, profile=None) Given a valid config, update the Lifecycle rules for a bucket.
Returns {updated: true} if Lifecycle was updated and returns {updated: False} if Lifecycle was not updated.
salt myminion boto_s3_bucket.put_lifecycle_configuration my_bucket '[{\ "Expiration": {...},\ "ID": "idstring",\ "Prefix": "prefixstring",\ "Status": "enabled",\ "Transitions": [{...},],\ "NoncurrentVersionTransitions": [{...},],\ "NoncurrentVersionExpiration": {...},\ }]'
salt.modules.boto_s3_bucket.put_logging(Bucket, TargetBucket=None, TargetPrefix=None, TargetGrants=None, region=None, key=None, keyid=None, profile=None) Given a valid config, update the logging parameters for a bucket.
Returns {updated: true} if parameters were updated and returns {updated: False} if parameters were not updated.
salt myminion boto_s3_bucket.put_logging my_bucket log_bucket '[{...}]' prefix
salt.modules.boto_s3_bucket.put_notification_configuration(Bucket, TopicConfigurations=None, QueueConfigurations=None, LambdaFunctionConfigurations=None, region=None, key=None, keyid=None, profile=None) Given a valid config, update the notification parameters for a bucket.
salt myminion boto_s3_bucket.put_notification_configuration my_bucket [{...}] \ [{...}] \ [{...}]
salt.modules.boto_s3_bucket.put_policy(Bucket, Policy, region=None, key=None, keyid=None, profile=None) Given a valid config, update the policy for a bucket.
Returns {updated: true} if policy was updated and returns {updated: False} if policy was not updated.
salt myminion boto_s3_bucket.put_policy my_bucket {...}
salt.modules.boto_s3_bucket.put_replication(Bucket, Role, Rules, region=None, key=None, keyid=None, profile=None) Given a valid config, update the replication configuration for a bucket.
Returns {updated: true} if replication configuration was updated and returns {updated: False} if replication configuration was not updated.
salt myminion boto_s3_bucket.put_replication my_bucket my_role [...]
salt.modules.boto_s3_bucket.put_request_payment(Bucket, Payer, region=None, key=None, keyid=None, profile=None) Given a valid config, update the request payment configuration for a bucket.
Returns {updated: true} if request payment configuration was updated and returns {updated: False} if request payment configuration was not updated.
salt myminion boto_s3_bucket.put_request_payment my_bucket Requester
salt.modules.boto_s3_bucket.put_tagging(Bucket, region=None, key=None, keyid=None, profile=None, **kwargs) Given a valid config, update the tags for a bucket.
Returns {updated: true} if tags were updated and returns {updated: False} if tags were not updated.
salt myminion boto_s3_bucket.put_tagging my_bucket my_role [...]
salt.modules.boto_s3_bucket.put_versioning(Bucket, Status, MFADelete=None, MFA=None, region=None, key=None, keyid=None, profile=None) Given a valid config, update the versioning configuration for a bucket.
Returns {updated: true} if versioning configuration was updated and returns {updated: False} if versioning configuration was not updated.
salt myminion boto_s3_bucket.put_versioning my_bucket Enabled
salt.modules.boto_s3_bucket.put_website(Bucket, ErrorDocument=None, IndexDocument=None, RedirectAllRequestsTo=None, RoutingRules=None, region=None, key=None, keyid=None, profile=None) Given a valid config, update the website configuration for a bucket.
Returns {updated: true} if website configuration was updated and returns {updated: False} if website configuration was not updated.
salt myminion boto_s3_bucket.put_website my_bucket IndexDocument='{"Suffix":"index.html"}'
salt.modules.boto_secgroup Connection module for Amazon Security Groups
configuration This module accepts explicit ec2 credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at:
secgroup.keyid: GKTADJGHEIQSXMKKRBJ08H secgroup.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
secgroup.region: us-east-1
salt.modules.boto_secgroup.authorize(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False) Add a new rule to an existing security group.
salt myminion boto_secgroup.authorize mysecgroup ip_protocol=tcp from_port=80 to_port=80 cidr_ip='['10.0.0.0/8', '192.168.0.0/24']'
salt.modules.boto_secgroup.convert_to_group_ids(groups, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None) Given a list of security groups and a vpc_id, convert_to_group_ids will convert all list items in the given list to security group ids.
salt myminion boto_secgroup.convert_to_group_ids mysecgroup vpc-89yhh7h
salt.modules.boto_secgroup.create(name, description, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None) Create a security group.
salt myminion boto_secgroup.create mysecgroup 'My Security Group'
salt.modules.boto_secgroup.delete(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None) Delete a security group.
salt myminion boto_secgroup.delete mysecgroup
salt.modules.boto_secgroup.delete_tags(tags, name=None, group_id=None, vpc_name=None, vpc_id=None, region=None, key=None, keyid=None, profile=None) Deletes tags from a security group.
tags   a list of tags to remove
name   the name of the security group
group_id the group id of the security group (in lie of a name/vpc combo)
vpc_name the name of the vpc to search the named group for
vpc_id the id of the vpc, in lieu of the vpc_name
region the amazon region
key    amazon key
keyid  amazon keyid
profile amazon profile
salt myminion boto_secgroup.delete_tags ['TAG_TO_DELETE1','TAG_TO_DELETE2'] security_group_name vpc_id=vpc-13435 profile=my_aws_profile
salt.modules.boto_secgroup.exists(name=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, group_id=None) Check to see if a security group exists.
salt myminion boto_secgroup.exists mysecgroup
salt.modules.boto_secgroup.get_all_security_groups(groupnames=None, group_ids=None, filters=None, region=None, key=None, keyid=None, profile=None) Return a list of all Security Groups matching the given criteria and filters.
Note that the groupnames argument only functions correctly for EC2 Classic and default VPC Security Groups.  To find groups by name in other VPCs you'll want to use the group-name filter instead.
The valid keys for the filters argument can be found in AWS's API documentation.
salt myminion boto_secgroup.get_all_security_groups filters='{group-name: mygroup}'
salt.modules.boto_secgroup.get_config(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None) Get the configuration for a security group.
salt myminion boto_secgroup.get_config mysecgroup
salt.modules.boto_secgroup.get_group_id(name, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None) Get a Group ID given a Group Name or Group Name and VPC ID
salt myminion boto_secgroup.get_group_id mysecgroup
salt.modules.boto_secgroup.revoke(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False) Remove a rule from an existing security group.
salt myminion boto_secgroup.revoke mysecgroup ip_protocol=tcp from_port=80 to_port=80 cidr_ip='10.0.0.0/8'
salt.modules.boto_secgroup.set_tags(tags, name=None, group_id=None, vpc_name=None, vpc_id=None, region=None, key=None, keyid=None, profile=None) Sets tags on a security group.
tags   a dict of key:value pair of tags to set on the security group
salt myminion boto_secgroup.set_tags "{'TAG1': 'Value1', 'TAG2': 'Value2'}" security_group_name vpc_id=vpc-13435 profile=my_aws_profile
salt.modules.boto_sns Connection module for Amazon SNS
salt.modules.boto_sns.create(name, region=None, key=None, keyid=None, profile=None) Create an SNS topic.
CLI example to create a topic:
salt myminion boto_sns.create mytopic region=us-east-1
salt.modules.boto_sns.delete(name, region=None, key=None, keyid=None, profile=None) Delete an SNS topic.
CLI example to delete a topic:
salt myminion boto_sns.delete mytopic region=us-east-1
salt.modules.boto_sns.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an SNS topic exists.
salt myminion boto_sns.exists mytopic region=us-east-1
salt.modules.boto_sns.get_all_subscriptions_by_topic(name, region=None, key=None, keyid=None, profile=None) Get list of all subscriptions to a specific topic.
salt myminion boto_sns.get_all_subscriptions_by_topic mytopic region=us-east-1
salt.modules.boto_sns.get_all_topics(region=None, key=None, keyid=None, profile=None) Returns a list of the all topics..
salt myminion boto_sns.get_all_topics
salt.modules.boto_sns.get_arn(name, region=None, key=None, keyid=None, profile=None) Returns the full ARN for a given topic name.
salt myminion boto_sns.get_arn mytopic
salt.modules.boto_sns.subscribe(topic, protocol, endpoint, region=None, key=None, keyid=None, profile=None) Subscribe to a Topic.
salt myminion boto_sns.subscribe mytopic https https://www.example.com/sns-endpoint region=us-east-1
salt.modules.boto_sns.unsubscribe(topic, subscription_arn, region=None, key=None, keyid=None, profile=None) Unsubscribe a specific SubscriptionArn of a topic.
salt myminion boto_sns.unsubscribe my_topic my_subscription_arn region=us-east-1
salt.modules.boto_sqs Connection module for Amazon SQS
configuration This module accepts explicit sqs credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available at:
salt.modules.boto_sqs.create(name, attributes=None, region=None, key=None, keyid=None, profile=None) Create an SQS queue.
salt myminion boto_sqs.create myqueue region=us-east-1
salt.modules.boto_sqs.delete(name, region=None, key=None, keyid=None, profile=None) Delete an SQS queue.
salt myminion boto_sqs.delete myqueue region=us-east-1
salt.modules.boto_sqs.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if a queue exists.
salt myminion boto_sqs.exists myqueue region=us-east-1
salt.modules.boto_sqs.get_attributes(name, region=None, key=None, keyid=None, profile=None) Return attributes currently set on an SQS queue.
salt myminion boto_sqs.get_attributes myqueue
salt.modules.boto_sqs.list_(prefix='', region=None, key=None, keyid=None, profile=None) Return a list of the names of all visible queues.
salt myminion boto_sqs.list region=us-east-1
salt.modules.boto_sqs.set_attributes(name, attributes, region=None, key=None, keyid=None, profile=None) Set attributes on an SQS queue.
salt myminion boto_sqs.set_attributes myqueue '{ReceiveMessageWaitTimeSeconds: 20}' region=us-east-1
salt.modules.boto_ssm Connection module for Amazon SSM
configuration This module uses IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at:
salt.modules.boto_ssm.delete_parameter(Name, region=None, key=None, keyid=None, profile=None) Removes a parameter from the SSM parameter store
salt-call boto_ssm.delete_parameter test-param
salt.modules.boto_ssm.get_parameter(name, withdecryption=False, resp_json=False, region=None, key=None, keyid=None, profile=None) Retrieves a parameter from SSM Parameter Store
salt-call boto_ssm.get_parameter test-param withdescription=True
salt.modules.boto_ssm.put_parameter(Name, Value, Description=None, Type='String', KeyId=None, Overwrite=False, AllowedPattern=None, region=None, key=None, keyid=None, profile=None) Sets a parameter in the SSM parameter store
salt-call boto_ssm.put_parameter test-param test_value Type=SecureString KeyId=alias/aws/ssm Description='test encrypted key'
salt.modules.boto_vpc Connection module for Amazon VPC
• boto3 >= 1.2.6
configuration This module accepts explicit VPC credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available here.
vpc.keyid: GKTADJGHEIQSXMKKRBJ08H vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
vpc.region: us-east-1
Request methods (e.g., describe_vpc) return:
vpcs: - {...} - {...}
Functions to request, accept, delete and describe VPC peering connections.  Named VPC peering connections can be requested using these modules.  VPC owner accounts can accept VPC peering connections (named or otherwise).
Examples showing creation of VPC peering connection
# Create a named VPC peering connection salt myminion boto_vpc.request_vpc_peering_connection vpc-4a3e622e vpc-be82e9da name=my_vpc_connection # Without a name salt myminion boto_vpc.request_vpc_peering_connection vpc-4a3e622e vpc-be82e9da # Specify a region salt myminion boto_vpc.request_vpc_peering_connection vpc-4a3e622e vpc-be82e9da region=us-west-2
Check to see if VPC peering connection is pending