Package 'paws.mobile'

Title: 'Amazon Web Services' Mobile Services
Description: Interface to 'Amazon Web Services' mobile services, including the 'Amplify' library for mobile applications, 'AppSync' back-end for mobile applications, 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-10-04 09:26:47 UTC
Source: https://github.com/paws-r/paws

Help Index


AWS Amplify

Description

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Usage

amplify(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

svc <- amplify(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_app Creates a new Amplify app
create_backend_environment Creates a new backend environment for an Amplify app
create_branch Creates a new branch for an Amplify app
create_deployment Creates a deployment for a manually deployed Amplify app
create_domain_association Creates a new domain association for an Amplify app
create_webhook Creates a new webhook on an Amplify app
delete_app Deletes an existing Amplify app specified by an app ID
delete_backend_environment Deletes a backend environment for an Amplify app
delete_branch Deletes a branch for an Amplify app
delete_domain_association Deletes a domain association for an Amplify app
delete_job Deletes a job for a branch of an Amplify app
delete_webhook Deletes a webhook
generate_access_logs Returns the website access logs for a specific time range using a presigned URL
get_app Returns an existing Amplify app by appID
get_artifact_url Returns the artifact info that corresponds to an artifact id
get_backend_environment Returns a backend environment for an Amplify app
get_branch Returns a branch for an Amplify app
get_domain_association Returns the domain information for an Amplify app
get_job Returns a job for a branch of an Amplify app
get_webhook Returns the webhook information that corresponds to a specified webhook ID
list_apps Returns a list of the existing Amplify apps
list_artifacts Returns a list of artifacts for a specified app, branch, and job
list_backend_environments Lists the backend environments for an Amplify app
list_branches Lists the branches of an Amplify app
list_domain_associations Returns the domain associations for an Amplify app
list_jobs Lists the jobs for a branch of an Amplify app
list_tags_for_resource Returns a list of tags for a specified Amazon Resource Name (ARN)
list_webhooks Returns a list of webhooks for an Amplify app
start_deployment Starts a deployment for a manually deployed app
start_job Starts a new job for a branch of an Amplify app
stop_job Stops a job that is in progress for a branch of an Amplify app
tag_resource Tags the resource with a tag key and value
untag_resource Untags a resource with a specified Amazon Resource Name (ARN)
update_app Updates an existing Amplify app
update_branch Updates a branch for an Amplify app
update_domain_association Creates a new domain association for an Amplify app
update_webhook Updates a webhook

Examples

## Not run: 
svc <- amplify()
svc$create_app(
  Foo = 123
)

## End(Not run)

AWS AppSync

Description

AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

Usage

appsync(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

svc <- appsync(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_api_cache Creates a cache for the GraphQL API
create_api_key Creates a unique key that you can distribute to clients who are executing your API
create_data_source Creates a DataSource object
create_function Creates a Function object
create_graphql_api Creates a GraphqlApi object
create_resolver Creates a Resolver object
create_type Creates a Type object
delete_api_cache Deletes an ApiCache object
delete_api_key Deletes an API key
delete_data_source Deletes a DataSource object
delete_function Deletes a Function
delete_graphql_api Deletes a GraphqlApi object
delete_resolver Deletes a Resolver object
delete_type Deletes a Type object
flush_api_cache Flushes an ApiCache object
get_api_cache Retrieves an ApiCache object
get_data_source Retrieves a DataSource object
get_function Get a Function
get_graphql_api Retrieves a GraphqlApi object
get_introspection_schema Retrieves the introspection schema for a GraphQL API
get_resolver Retrieves a Resolver object
get_schema_creation_status Retrieves the current status of a schema creation operation
get_type Retrieves a Type object
list_api_keys Lists the API keys for a given API
list_data_sources Lists the data sources for a given API
list_functions List multiple functions
list_graphql_apis Lists your GraphQL APIs
list_resolvers Lists the resolvers for a given API and type
list_resolvers_by_function List the resolvers that are associated with a specific function
list_tags_for_resource Lists the tags for a resource
list_types Lists the types for a given API
start_schema_creation Adds a new schema to your GraphQL API
tag_resource Tags a resource with user-supplied tags
untag_resource Untags a resource
update_api_cache Updates the cache for the GraphQL API
update_api_key Updates an API key
update_data_source Updates a DataSource object
update_function Updates a Function object
update_graphql_api Updates a GraphqlApi object
update_resolver Updates a Resolver object
update_type Updates a Type object

Examples

## Not run: 
svc <- appsync()
svc$create_api_cache(
  Foo = 123
)

## End(Not run)

AWS Device Farm

Description

Welcome to the AWS Device Farm API documentation, which contains APIs for:

  • Testing on desktop browsers

    Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm.

  • Testing on real mobile devices

    Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.

Usage

devicefarm(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

svc <- devicefarm(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_device_pool Creates a device pool
create_instance_profile Creates a profile that can be applied to one or more private fleet device instances
create_network_profile Creates a network profile
create_project Creates a project
create_remote_access_session Specifies and starts a remote access session
create_test_grid_project Creates a Selenium testing project
create_test_grid_url Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor
create_upload Uploads an app or test scripts
create_vpce_configuration Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint
delete_device_pool Deletes a device pool given the pool ARN
delete_instance_profile Deletes a profile that can be applied to one or more private device instances
delete_network_profile Deletes a network profile
delete_project Deletes an AWS Device Farm project, given the project ARN
delete_remote_access_session Deletes a completed remote access session and its results
delete_run Deletes the run, given the run ARN
delete_test_grid_project Deletes a Selenium testing project and all content generated under it
delete_upload Deletes an upload given the upload ARN
delete_vpce_configuration Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint
get_account_settings Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account
get_device Gets information about a unique device type
get_device_instance Returns information about a device instance that belongs to a private device fleet
get_device_pool Gets information about a device pool
get_device_pool_compatibility Gets information about compatibility with a device pool
get_instance_profile Returns information about the specified instance profile
get_job Gets information about a job
get_network_profile Returns information about a network profile
get_offering_status Gets the current status and future status of all offerings purchased by an AWS account
get_project Gets information about a project
get_remote_access_session Returns a link to a currently running remote access session
get_run Gets information about a run
get_suite Gets information about a suite
get_test Gets information about a test
get_test_grid_project Retrieves information about a Selenium testing project
get_test_grid_session A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url
get_upload Gets information about an upload
get_vpce_configuration Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint
install_to_remote_access_session Installs an application to the device in a remote access session
list_artifacts Gets information about artifacts
list_device_instances Returns information about the private device instances associated with one or more AWS accounts
list_device_pools Gets information about device pools
list_devices Gets information about unique device types
list_instance_profiles Returns information about all the instance profiles in an AWS account
list_jobs Gets information about jobs for a given test run
list_network_profiles Returns the list of available network profiles
list_offering_promotions Returns a list of offering promotions
list_offerings Returns a list of products or offerings that the user can manage through the API
list_offering_transactions Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account
list_projects Gets information about projects
list_remote_access_sessions Returns a list of all currently running remote access sessions
list_runs Gets information about runs, given an AWS Device Farm project ARN
list_samples Gets information about samples, given an AWS Device Farm job ARN
list_suites Gets information about test suites for a given job
list_tags_for_resource List the tags for an AWS Device Farm resource
list_test_grid_projects Gets a list of all Selenium testing projects in your account
list_test_grid_session_actions Returns a list of the actions taken in a TestGridSession
list_test_grid_session_artifacts Retrieves a list of artifacts created during the session
list_test_grid_sessions Retrieves a list of sessions for a TestGridProject
list_tests Gets information about tests in a given test suite
list_unique_problems Gets information about unique problems, such as exceptions or crashes
list_uploads Gets information about uploads, given an AWS Device Farm project ARN
list_vpce_configurations Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account
purchase_offering Immediately purchases offerings for an AWS account
renew_offering Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period
schedule_run Schedules a run
stop_job Initiates a stop request for the current job
stop_remote_access_session Ends a specified remote access session
stop_run Initiates a stop request for the current test run
tag_resource Associates the specified tags to a resource with the specified resourceArn
untag_resource Deletes the specified tags from a resource
update_device_instance Updates information about a private device instance
update_device_pool Modifies the name, description, and rules in a device pool given the attributes and the pool ARN
update_instance_profile Updates information about an existing private device instance profile
update_network_profile Updates the network profile
update_project Modifies the specified project name, given the project ARN and a new name
update_test_grid_project Change details of a project
update_upload Updates an uploaded test spec
update_vpce_configuration Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration

Examples

## Not run: 
svc <- devicefarm()
# The following example creates a new device pool named MyDevicePool
# inside an existing project.
svc$create_device_pool(
  name = "MyDevicePool",
  description = "My Android devices",
  projectArn = "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
  rules = list()
)

## End(Not run)

AWS Mobile

Description

AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

Usage

mobile(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

svc <- mobile(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_project Creates an AWS Mobile Hub project
delete_project Delets a project in AWS Mobile Hub
describe_bundle Get the bundle details for the requested bundle id
describe_project Gets details about a project in AWS Mobile Hub
export_bundle Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources
export_project Exports project configuration to a snapshot which can be downloaded and shared
list_bundles List all available bundles
list_projects Lists projects in AWS Mobile Hub
update_project Update an existing project

Examples

## Not run: 
svc <- mobile()
svc$create_project(
  Foo = 123
)

## End(Not run)

Amazon Mobile Analytics

Description

Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.

Usage

mobileanalytics(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

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.

Service syntax

svc <- mobileanalytics(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

put_events The PutEvents operation records one or more events

Examples

## Not run: 
svc <- mobileanalytics()
svc$put_events(
  Foo = 123
)

## End(Not run)