Title: | 'Amazon Web Services' Application Integration Services |
---|---|
Description: | Interface to 'Amazon Web Services' application integration services, including 'Simple Queue Service' ('SQS') message queue, 'Simple Notification Service' ('SNS') publish/subscribe messaging, and more <https://aws.amazon.com/>. |
Authors: | David Kretch [aut], Adam Banker [aut], Dyfan Jones [cre], Amazon.com, Inc. [cph] |
Maintainer: | Dyfan Jones <[email protected]> |
License: | Apache License (>= 2.0) |
Version: | 0.7.0 |
Built: | 2024-11-03 06:30:00 UTC |
Source: | https://github.com/paws-r/paws |
Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:
Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.
eventbridge( config = list(), credentials = list(), endpoint = NULL, region = NULL )
eventbridge( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- eventbridge( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
activate_event_source | Activates a partner event source that has been deactivated |
cancel_replay | Cancels the specified replay |
create_api_destination | Creates an API destination, which is an HTTP invocation endpoint configured as a target for events |
create_archive | Creates an archive of events with the specified settings |
create_connection | Creates a connection |
create_endpoint | Creates a global endpoint |
create_event_bus | Creates a new event bus within your account |
create_partner_event_source | Called by an SaaS partner to create a partner event source |
deactivate_event_source | You can use this operation to temporarily stop receiving events from the specified partner event source |
deauthorize_connection | Removes all authorization parameters from the connection |
delete_api_destination | Deletes the specified API destination |
delete_archive | Deletes the specified archive |
delete_connection | Deletes a connection |
delete_endpoint | Delete an existing global endpoint |
delete_event_bus | Deletes the specified custom event bus or partner event bus |
delete_partner_event_source | This operation is used by SaaS partners to delete a partner event source |
delete_rule | Deletes the specified rule |
describe_api_destination | Retrieves details about an API destination |
describe_archive | Retrieves details about an archive |
describe_connection | Retrieves details about a connection |
describe_endpoint | Get the information about an existing global endpoint |
describe_event_bus | Displays details about an event bus in your account |
describe_event_source | This operation lists details about a partner event source that is shared with your account |
describe_partner_event_source | An SaaS partner can use this operation to list details about a partner event source that they have created |
describe_replay | Retrieves details about a replay |
describe_rule | Describes the specified rule |
disable_rule | Disables the specified rule |
enable_rule | Enables the specified rule |
list_api_destinations | Retrieves a list of API destination in the account in the current Region |
list_archives | Lists your archives |
list_connections | Retrieves a list of connections from the account |
list_endpoints | List the global endpoints associated with this account |
list_event_buses | Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses |
list_event_sources | You can use this to see all the partner event sources that have been shared with your Amazon Web Services account |
list_partner_event_source_accounts | An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with |
list_partner_event_sources | An SaaS partner can use this operation to list all the partner event source names that they have created |
list_replays | Lists your replays |
list_rule_names_by_target | Lists the rules for the specified target |
list_rules | Lists your Amazon EventBridge rules |
list_tags_for_resource | Displays the tags associated with an EventBridge resource |
list_targets_by_rule | Lists the targets assigned to the specified rule |
put_events | Sends custom events to Amazon EventBridge so that they can be matched to rules |
put_partner_events | This is used by SaaS partners to write events to a customer's partner event bus |
put_permission | Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus |
put_rule | Creates or updates the specified rule |
put_targets | Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule |
remove_permission | Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus |
remove_targets | Removes the specified targets from the specified rule |
start_replay | Starts the specified replay |
tag_resource | Assigns one or more tags (key-value pairs) to the specified EventBridge resource |
test_event_pattern | Tests whether the specified event pattern matches the provided event |
untag_resource | Removes one or more tags from the specified EventBridge resource |
update_api_destination | Updates an API destination |
update_archive | Updates the specified archive |
update_connection | Updates settings for a connection |
update_endpoint | Update an existing endpoint |
update_event_bus | Updates the specified event bus |
## Not run: svc <- eventbridge() svc$activate_event_source( Foo = 123 ) ## End(Not run)
## Not run: svc <- eventbridge() svc$activate_event_source( Foo = 123 ) ## End(Not run)
Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.
eventbridgepipes( config = list(), credentials = list(), endpoint = NULL, region = NULL )
eventbridgepipes( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- eventbridgepipes( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_pipe | Create a pipe |
delete_pipe | Delete an existing pipe |
describe_pipe | Get the information about an existing pipe |
list_pipes | Get the pipes associated with this account |
list_tags_for_resource | Displays the tags associated with a pipe |
start_pipe | Start an existing pipe |
stop_pipe | Stop an existing pipe |
tag_resource | Assigns one or more tags (key-value pairs) to the specified pipe |
untag_resource | Removes one or more tags from the specified pipes |
update_pipe | Update an existing pipe |
## Not run: svc <- eventbridgepipes() svc$create_pipe( Foo = 123 ) ## End(Not run)
## Not run: svc <- eventbridgepipes() svc$create_pipe( Foo = 123 ) ## End(Not run)
Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.
eventbridgescheduler( config = list(), credentials = list(), endpoint = NULL, region = NULL )
eventbridgescheduler( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- eventbridgescheduler( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_schedule | Creates the specified schedule |
create_schedule_group | Creates the specified schedule group |
delete_schedule | Deletes the specified schedule |
delete_schedule_group | Deletes the specified schedule group |
get_schedule | Retrieves the specified schedule |
get_schedule_group | Retrieves the specified schedule group |
list_schedule_groups | Returns a paginated list of your schedule groups |
list_schedules | Returns a paginated list of your EventBridge Scheduler schedules |
list_tags_for_resource | Lists the tags associated with the Scheduler resource |
tag_resource | Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource |
untag_resource | Removes one or more tags from the specified EventBridge Scheduler schedule group |
update_schedule | Updates the specified schedule |
## Not run: svc <- eventbridgescheduler() svc$create_schedule( Foo = 123 ) ## End(Not run)
## Not run: svc <- eventbridgescheduler() svc$create_schedule( Foo = 123 ) ## End(Not run)
"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
locationservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
locationservice( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- locationservice( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
associate_tracker_consumer | Creates an association between a geofence collection and a tracker resource |
batch_delete_device_position_history | Deletes the position history of one or more devices from a tracker resource |
batch_delete_geofence | Deletes a batch of geofences from a geofence collection |
batch_evaluate_geofences | Evaluates device positions against the geofence geometries from a given geofence collection |
batch_get_device_position | Lists the latest device positions for requested devices |
batch_put_geofence | A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request |
batch_update_device_position | Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch) |
calculate_route | Calculates a route given the following required parameters: DeparturePosition and DestinationPosition |
calculate_route_matrix | Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions |
create_geofence_collection | Creates a geofence collection, which manages and stores geofences |
create_key | Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer |
create_map | Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers |
create_place_index | Creates a place index resource in your Amazon Web Services account |
create_route_calculator | Creates a route calculator resource in your Amazon Web Services account |
create_tracker | Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices |
delete_geofence_collection | Deletes a geofence collection from your Amazon Web Services account |
delete_key | Deletes the specified API key |
delete_map | Deletes a map resource from your Amazon Web Services account |
delete_place_index | Deletes a place index resource from your Amazon Web Services account |
delete_route_calculator | Deletes a route calculator resource from your Amazon Web Services account |
delete_tracker | Deletes a tracker resource from your Amazon Web Services account |
describe_geofence_collection | Retrieves the geofence collection details |
describe_key | Retrieves the API key resource details |
describe_map | Retrieves the map resource details |
describe_place_index | Retrieves the place index resource details |
describe_route_calculator | Retrieves the route calculator resource details |
describe_tracker | Retrieves the tracker resource details |
disassociate_tracker_consumer | Removes the association between a tracker resource and a geofence collection |
forecast_geofence_events | Evaluates device positions against geofence geometries from a given geofence collection |
get_device_position | Retrieves a device's most recent position according to its sample time |
get_device_position_history | Retrieves the device position history from a tracker resource within a specified range of time |
get_geofence | Retrieves the geofence details from a geofence collection |
get_map_glyphs | Retrieves glyphs used to display labels on a map |
get_map_sprites | Retrieves the sprite sheet corresponding to a map resource |
get_map_style_descriptor | Retrieves the map style descriptor from a map resource |
get_map_tile | Retrieves a vector data tile from the map resource |
get_place | Finds a place by its unique ID |
list_device_positions | A batch request to retrieve all device positions |
list_geofence_collections | Lists geofence collections in your Amazon Web Services account |
list_geofences | Lists geofences stored in a given geofence collection |
list_keys | Lists API key resources in your Amazon Web Services account |
list_maps | Lists map resources in your Amazon Web Services account |
list_place_indexes | Lists place index resources in your Amazon Web Services account |
list_route_calculators | Lists route calculator resources in your Amazon Web Services account |
list_tags_for_resource | Returns a list of tags that are applied to the specified Amazon Location resource |
list_tracker_consumers | Lists geofence collections currently associated to the given tracker resource |
list_trackers | Lists tracker resources in your Amazon Web Services account |
put_geofence | Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request |
search_place_index_for_position | Reverse geocodes a given coordinate and returns a legible address |
search_place_index_for_suggestions | Generates suggestions for addresses and points of interest based on partial or misspelled free-form text |
search_place_index_for_text | Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest |
tag_resource | Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource |
untag_resource | Removes one or more tags from the specified Amazon Location resource |
update_geofence_collection | Updates the specified properties of a given geofence collection |
update_key | Updates the specified properties of a given API key resource |
update_map | Updates the specified properties of a given map resource |
update_place_index | Updates the specified properties of a given place index resource |
update_route_calculator | Updates the specified properties for a given route calculator resource |
update_tracker | Updates the specified properties of a given tracker resource |
verify_device_position | Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state |
## Not run: svc <- locationservice() svc$associate_tracker_consumer( Foo = 123 ) ## End(Not run)
## Not run: svc <- locationservice() svc$associate_tracker_consumer( Foo = 123 ) ## End(Not run)
Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
mq(config = list(), credentials = list(), endpoint = NULL, region = NULL)
mq(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- mq( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_broker | Creates a broker |
create_configuration | Creates a new configuration for the specified configuration name |
create_tags | Add a tag to a resource |
create_user | Creates an ActiveMQ user |
delete_broker | Deletes a broker |
delete_tags | Removes a tag from a resource |
delete_user | Deletes an ActiveMQ user |
describe_broker | Returns information about the specified broker |
describe_broker_engine_types | Describe available engine types and versions |
describe_broker_instance_options | Describe available broker instance options |
describe_configuration | Returns information about the specified configuration |
describe_configuration_revision | Returns the specified configuration revision for the specified configuration |
describe_user | Returns information about an ActiveMQ user |
list_brokers | Returns a list of all brokers |
list_configuration_revisions | Returns a list of all revisions for the specified configuration |
list_configurations | Returns a list of all configurations |
list_tags | Lists tags for a resource |
list_users | Returns a list of all ActiveMQ users |
promote | Promotes a data replication replica broker to the primary broker role |
reboot_broker | Reboots a broker |
update_broker | Adds a pending configuration change to a broker |
update_configuration | Updates the specified configuration |
update_user | Updates the information for an ActiveMQ user |
## Not run: svc <- mq() svc$create_broker( Foo = 123 ) ## End(Not run)
## Not run: svc <- mq() svc$create_broker( Foo = 123 ) ## End(Not run)
Amazon Managed Workflows for Apache Airflow
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What is Amazon MWAA?.
Endpoints
api.airflow.{region}.amazonaws.com
- This endpoint is used for
environment management.
env.airflow.{region}.amazonaws.com
- This endpoint is used to
operate the Airflow environment.
Regions
For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.
mwaa(config = list(), credentials = list(), endpoint = NULL, region = NULL)
mwaa(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- mwaa( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_cli_token | Creates a CLI token for the Airflow CLI |
create_environment | Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment |
create_web_login_token | Creates a web login token for the Airflow Web UI |
delete_environment | Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment |
get_environment | Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment |
list_environments | Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments |
list_tags_for_resource | Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment |
publish_metrics | Internal only |
tag_resource | Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment |
untag_resource | Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment |
update_environment | Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment |
## Not run: svc <- mwaa() svc$create_cli_token( Foo = 123 ) ## End(Not run)
## Not run: svc <- mwaa() svc$create_cli_token( Foo = 123 ) ## End(Not run)
Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.
Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.
You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.
For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.
resourceexplorer( config = list(), credentials = list(), endpoint = NULL, region = NULL )
resourceexplorer( config = list(), credentials = list(), endpoint = NULL, region = NULL )
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- resourceexplorer( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
associate_default_view | Sets the specified view as the default for the Amazon Web Services Region in which you call this operation |
batch_get_view | Retrieves details about a list of views |
create_index | Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index |
create_view | Creates a view that users can query by using the Search operation |
delete_index | Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region |
delete_view | Deletes the specified view |
disassociate_default_view | After you call this operation, the affected Amazon Web Services Region no longer has a default view |
get_account_level_service_configuration | Retrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature |
get_default_view | Retrieves the Amazon Resource Name (ARN) of the view that is the default for the Amazon Web Services Region in which you call this operation |
get_index | Retrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation |
get_view | Retrieves details of the specified view |
list_indexes | Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer |
list_indexes_for_members | Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer |
list_supported_resource_types | Retrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer |
list_tags_for_resource | Lists the tags that are attached to the specified resource |
list_views | Lists the Amazon resource names (ARNs) of the views available in the Amazon Web Services Region in which you call this operation |
search | Searches for resources and displays details about all resources that match the specified criteria |
tag_resource | Adds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index |
untag_resource | Removes one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index |
update_index_type | Changes the type of the index from one of the following types to the other |
update_view | Modifies some of the details of a view |
## Not run: svc <- resourceexplorer() svc$associate_default_view( Foo = 123 ) ## End(Not run)
## Not run: svc <- resourceexplorer() svc$associate_default_view( Foo = 123 ) ## End(Not run)
Amazon EventBridge Schema Registry
schemas(config = list(), credentials = list(), endpoint = NULL, region = NULL)
schemas(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- schemas( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_discoverer | Creates a discoverer |
create_registry | Creates a registry |
create_schema | Creates a schema definition |
delete_discoverer | Deletes a discoverer |
delete_registry | Deletes a Registry |
delete_resource_policy | Delete the resource-based policy attached to the specified registry |
delete_schema | Delete a schema definition |
delete_schema_version | Delete the schema version definition |
describe_code_binding | Describe the code binding URI |
describe_discoverer | Describes the discoverer |
describe_registry | Describes the registry |
describe_schema | Retrieve the schema definition |
export_schema | Export schema |
get_code_binding_source | Get the code binding source URI |
get_discovered_schema | Get the discovered schema that was generated based on sampled events |
get_resource_policy | Retrieves the resource-based policy attached to a given registry |
list_discoverers | List the discoverers |
list_registries | List the registries |
list_schemas | List the schemas |
list_schema_versions | Provides a list of the schema versions and related information |
list_tags_for_resource | Get tags for resource |
put_code_binding | Put code binding URI |
put_resource_policy | The name of the policy |
search_schemas | Search the schemas |
start_discoverer | Starts the discoverer |
stop_discoverer | Stops the discoverer |
tag_resource | Add tags to a resource |
untag_resource | Removes tags from a resource |
update_discoverer | Updates the discoverer |
update_registry | Updates a registry |
update_schema | Updates the schema definition |
## Not run: svc <- schemas() svc$create_discoverer( Foo = 123 ) ## End(Not run)
## Not run: svc <- schemas() svc$create_discoverer( Foo = 123 ) ## End(Not run)
Step Functions
Step Functions coordinates the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
If you use the Step Functions API actions using Amazon Web Services SDK
integrations, make sure the API actions are in camel case and parameter
names are in Pascal case. For example, you could use Step Functions API
action startSyncExecution
and specify its parameter as
StateMachineArn
.
sfn(config = list(), credentials = list(), endpoint = NULL, region = NULL)
sfn(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- sfn( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
create_activity | Creates an activity |
create_state_machine | Creates a state machine |
create_state_machine_alias | Creates an alias for a state machine that points to one or two versions of the same state machine |
delete_activity | Deletes an activity |
delete_state_machine | Deletes a state machine |
delete_state_machine_alias | Deletes a state machine alias |
delete_state_machine_version | Deletes a state machine version |
describe_activity | Describes an activity |
describe_execution | Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata |
describe_map_run | Provides information about a Map Run's configuration, progress, and results |
describe_state_machine | Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration |
describe_state_machine_alias | Returns details about a state machine alias |
describe_state_machine_for_execution | Provides information about a state machine's definition, its execution role ARN, and configuration |
get_activity_task | Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine |
get_execution_history | Returns the history of the specified execution as a list of events |
list_activities | Lists the existing activities |
list_executions | Lists all executions of a state machine or a Map Run |
list_map_runs | Lists all Map Runs that were started by a given state machine execution |
list_state_machine_aliases | Lists aliases for a specified state machine ARN |
list_state_machines | Lists the existing state machines |
list_state_machine_versions | Lists versions for the specified state machine Amazon Resource Name (ARN) |
list_tags_for_resource | List tags for a given resource |
publish_state_machine_version | Creates a version from the current revision of a state machine |
redrive_execution | Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days |
send_task_failure | Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed |
send_task_heartbeat | Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress |
send_task_success | Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully |
start_execution | Starts a state machine execution |
start_sync_execution | Starts a Synchronous Express state machine execution |
stop_execution | Stops an execution |
tag_resource | Add a tag to a Step Functions resource |
test_state | Accepts the definition of a single state and executes it |
untag_resource | Remove a tag from a Step Functions resource |
update_map_run | Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure |
update_state_machine | Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration |
update_state_machine_alias | Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration |
validate_state_machine_definition | Validates the syntax of a state machine definition |
## Not run: svc <- sfn() svc$create_activity( Foo = 123 ) ## End(Not run)
## Not run: svc <- sfn() svc$create_activity( Foo = 123 ) ## End(Not run)
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
sns(config = list(), credentials = list(), endpoint = NULL, region = NULL)
sns(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- sns( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
add_permission | Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions |
check_if_phone_number_is_opted_out | Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account |
confirm_subscription | Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action |
create_platform_application | Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register |
create_platform_endpoint | Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS |
create_sms_sandbox_phone_number | Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number |
create_topic | Creates a topic to which notifications can be published |
delete_endpoint | Deletes the endpoint for a device and mobile app from Amazon SNS |
delete_platform_application | Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging) |
delete_sms_sandbox_phone_number | Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox |
delete_topic | Deletes a topic and all its subscriptions |
get_data_protection_policy | Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic |
get_endpoint_attributes | Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS |
get_platform_application_attributes | Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging) |
get_sms_attributes | Returns the settings for sending SMS messages from your Amazon Web Services account |
get_sms_sandbox_account_status | Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region |
get_subscription_attributes | Returns all of the properties of a subscription |
get_topic_attributes | Returns all of the properties of a topic |
list_endpoints_by_platform_application | Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS |
list_origination_numbers | Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata |
list_phone_numbers_opted_out | Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them |
list_platform_applications | Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging) |
list_sms_sandbox_phone_numbers | Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox |
list_subscriptions | Returns a list of the requester's subscriptions |
list_subscriptions_by_topic | Returns a list of the subscriptions to a specific topic |
list_tags_for_resource | List all tags added to the specified Amazon SNS topic |
list_topics | Returns a list of the requester's topics |
opt_in_phone_number | Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number |
publish | Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn) |
publish_batch | Publishes up to ten messages to the specified topic |
put_data_protection_policy | Adds or updates an inline policy document that is stored in the specified Amazon SNS topic |
remove_permission | Removes a statement from a topic's access control policy |
set_endpoint_attributes | Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS |
set_platform_application_attributes | Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging) |
set_sms_attributes | Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports |
set_subscription_attributes | Allows a subscription owner to set an attribute of the subscription to a new value |
set_topic_attributes | Allows a topic owner to set an attribute of the topic to a new value |
subscribe | Subscribes an endpoint to an Amazon SNS topic |
tag_resource | Add tags to the specified Amazon SNS topic |
unsubscribe | Deletes a subscription |
untag_resource | Remove tags from the specified Amazon SNS topic |
verify_sms_sandbox_phone_number | Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account |
## Not run: svc <- sns() svc$add_permission( Foo = 123 ) ## End(Not run)
## Not run: svc <- sns() svc$add_permission( Foo = 123 ) ## End(Not run)
Welcome to the Amazon SQS API Reference.
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Developer Guide
Amazon Web Services General Reference
sqs(config = list(), credentials = list(), endpoint = NULL, region = NULL)
sqs(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- sqs( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
add_permission | Adds a permission to a queue for a specific principal |
cancel_message_move_task | Cancels a specified message movement task |
change_message_visibility | Changes the visibility timeout of a specified message in a queue to a new value |
change_message_visibility_batch | Changes the visibility timeout of multiple messages |
create_queue | Creates a new standard or FIFO queue |
delete_message | Deletes the specified message from the specified queue |
delete_message_batch | Deletes up to ten messages from the specified queue |
delete_queue | Deletes the queue specified by the QueueUrl, regardless of the queue's contents |
get_queue_attributes | Gets attributes for the specified queue |
get_queue_url | Returns the URL of an existing Amazon SQS queue |
list_dead_letter_source_queues | Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue |
list_message_move_tasks | Gets the most recent message movement tasks (up to 10) under a specific source queue |
list_queues | Returns a list of your queues in the current region |
list_queue_tags | List all cost allocation tags added to the specified Amazon SQS queue |
purge_queue | Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter |
receive_message | Retrieves one or more messages (up to 10), from the specified queue |
remove_permission | Revokes any permissions in the queue policy that matches the specified Label parameter |
send_message | Delivers a message to the specified queue |
send_message_batch | You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all) |
set_queue_attributes | Sets the value of one or more queue attributes, like a policy |
start_message_move_task | Starts an asynchronous task to move messages from a specified source queue to a specified destination queue |
tag_queue | Add cost allocation tags to the specified Amazon SQS queue |
untag_queue | Remove cost allocation tags from the specified Amazon SQS queue |
## Not run: svc <- sqs() svc$add_permission( Foo = 123 ) ## End(Not run)
## Not run: svc <- sqs() svc$add_permission( Foo = 123 ) ## End(Not run)
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .
swf(config = list(), credentials = list(), endpoint = NULL, region = NULL)
swf(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config |
Optional configuration of credentials, endpoint, and/or region.
|
credentials |
Optional credentials shorthand for the config parameter
|
endpoint |
Optional shorthand for complete URL to use for the constructed client. |
region |
Optional shorthand for AWS Region used in instantiating the client. |
A client for the service. You can call the service's operations using
syntax like svc$operation(...)
, where svc
is the name you've assigned
to the client. The available operations are listed in the
Operations section.
svc <- swf( config = list( credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string", close_connection = "logical", timeout = "numeric", s3_force_path_style = "logical", sts_regional_endpoint = "string" ), credentials = list( creds = list( access_key_id = "string", secret_access_key = "string", session_token = "string" ), profile = "string", anonymous = "logical" ), endpoint = "string", region = "string" )
count_closed_workflow_executions | Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria |
count_open_workflow_executions | Returns the number of open workflow executions within the given domain that meet the specified filtering criteria |
count_pending_activity_tasks | Returns the estimated number of activity tasks in the specified task list |
count_pending_decision_tasks | Returns the estimated number of decision tasks in the specified task list |
delete_activity_type | Deletes the specified activity type |
delete_workflow_type | Deletes the specified workflow type |
deprecate_activity_type | Deprecates the specified activity type |
deprecate_domain | Deprecates the specified domain |
deprecate_workflow_type | Deprecates the specified workflow type |
describe_activity_type | Returns information about the specified activity type |
describe_domain | Returns information about the specified domain, including description and status |
describe_workflow_execution | Returns information about the specified workflow execution including its type and some statistics |
describe_workflow_type | Returns information about the specified workflow type |
get_workflow_execution_history | Returns the history of the specified workflow execution |
list_activity_types | Returns information about all activities registered in the specified domain that match the specified name and registration status |
list_closed_workflow_executions | Returns a list of closed workflow executions in the specified domain that meet the filtering criteria |
list_domains | Returns the list of domains registered in the account |
list_open_workflow_executions | Returns a list of open workflow executions in the specified domain that meet the filtering criteria |
list_tags_for_resource | List tags for a given domain |
list_workflow_types | Returns information about workflow types in the specified domain |
poll_for_activity_task | Used by workers to get an ActivityTask from the specified activity taskList |
poll_for_decision_task | Used by deciders to get a DecisionTask from the specified decision taskList |
record_activity_task_heartbeat | Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress |
register_activity_type | Registers a new activity type along with its configuration settings in the specified domain |
register_domain | Registers a new domain |
register_workflow_type | Registers a new workflow type and its configuration settings in the specified domain |
request_cancel_workflow_execution | Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId |
respond_activity_task_canceled | Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled |
respond_activity_task_completed | Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided) |
respond_activity_task_failed | Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified) |
respond_decision_task_completed | Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed |
signal_workflow_execution | Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId |
start_workflow_execution | Starts an execution of the workflow type in the specified domain using the provided workflowId and input data |
tag_resource | Add a tag to a Amazon SWF domain |
terminate_workflow_execution | Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId |
undeprecate_activity_type | Undeprecates a previously deprecated activity type |
undeprecate_domain | Undeprecates a previously deprecated domain |
undeprecate_workflow_type | Undeprecates a previously deprecated workflow type |
untag_resource | Remove a tag from a Amazon SWF domain |
## Not run: svc <- swf() svc$count_closed_workflow_executions( Foo = 123 ) ## End(Not run)
## Not run: svc <- swf() svc$count_closed_workflow_executions( Foo = 123 ) ## End(Not run)