Package 'paws.end.user.computing'

Title: 'Amazon Web Services' End User Computing Services
Description: Interface to 'Amazon Web Services' end user computing services, including collaborative document editing, mobile intranet, 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 05:53:06 UTC
Source: https://github.com/paws-r/paws

Help Index


Amazon AppStream

Description

Amazon AppStream 2.0

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

To learn more about AppStream 2.0, see the following resources:

Usage

appstream(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- appstream(
  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"
)

Operations

associate_app_block_builder_app_block Associates the specified app block builder with the specified app block
associate_application_fleet Associates the specified application with the specified fleet
associate_application_to_entitlement Associates an application to entitle
associate_fleet Associates the specified fleet with the specified stack
batch_associate_user_stack Associates the specified users with the specified stacks
batch_disassociate_user_stack Disassociates the specified users from the specified stacks
copy_image Copies the image within the same region or to a new region within the same AWS account
create_app_block Creates an app block
create_app_block_builder Creates an app block builder
create_app_block_builder_streaming_url Creates a URL to start a create app block builder streaming session
create_application Creates an application
create_directory_config Creates a Directory Config object in AppStream 2
create_entitlement Creates a new entitlement
create_fleet Creates a fleet
create_image_builder Creates an image builder
create_image_builder_streaming_url Creates a URL to start an image builder streaming session
create_stack Creates a stack to start streaming applications to users
create_streaming_url Creates a temporary URL to start an AppStream 2
create_theme_for_stack Creates custom branding that customizes the appearance of the streaming application catalog page
create_updated_image Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2
create_usage_report_subscription Creates a usage report subscription
create_user Creates a new user in the user pool
delete_app_block Deletes an app block
delete_app_block_builder Deletes an app block builder
delete_application Deletes an application
delete_directory_config Deletes the specified Directory Config object from AppStream 2
delete_entitlement Deletes the specified entitlement
delete_fleet Deletes the specified fleet
delete_image Deletes the specified image
delete_image_builder Deletes the specified image builder and releases the capacity
delete_image_permissions Deletes permissions for the specified private image
delete_stack Deletes the specified stack
delete_theme_for_stack Deletes custom branding that customizes the appearance of the streaming application catalog page
delete_usage_report_subscription Disables usage report generation
delete_user Deletes a user from the user pool
describe_app_block_builder_app_block_associations Retrieves a list that describes one or more app block builder associations
describe_app_block_builders Retrieves a list that describes one or more app block builders
describe_app_blocks Retrieves a list that describes one or more app blocks
describe_application_fleet_associations Retrieves a list that describes one or more application fleet associations
describe_applications Retrieves a list that describes one or more applications
describe_directory_configs Retrieves a list that describes one or more specified Directory Config objects for AppStream 2
describe_entitlements Retrieves a list that describes one of more entitlements
describe_fleets Retrieves a list that describes one or more specified fleets, if the fleet names are provided
describe_image_builders Retrieves a list that describes one or more specified image builders, if the image builder names are provided
describe_image_permissions Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own
describe_images Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided
describe_sessions Retrieves a list that describes the streaming sessions for a specified stack and fleet
describe_stacks Retrieves a list that describes one or more specified stacks, if the stack names are provided
describe_theme_for_stack Retrieves a list that describes the theme for a specified stack
describe_usage_report_subscriptions Retrieves a list that describes one or more usage report subscriptions
describe_users Retrieves a list that describes one or more specified users in the user pool
describe_user_stack_associations Retrieves a list that describes the UserStackAssociation objects
disable_user Disables the specified user in the user pool
disassociate_app_block_builder_app_block Disassociates a specified app block builder from a specified app block
disassociate_application_fleet Disassociates the specified application from the fleet
disassociate_application_from_entitlement Deletes the specified application from the specified entitlement
disassociate_fleet Disassociates the specified fleet from the specified stack
enable_user Enables a user in the user pool
expire_session Immediately stops the specified streaming session
list_associated_fleets Retrieves the name of the fleet that is associated with the specified stack
list_associated_stacks Retrieves the name of the stack with which the specified fleet is associated
list_entitled_applications Retrieves a list of entitled applications
list_tags_for_resource Retrieves a list of all tags for the specified AppStream 2
start_app_block_builder Starts an app block builder
start_fleet Starts the specified fleet
start_image_builder Starts the specified image builder
stop_app_block_builder Stops an app block builder
stop_fleet Stops the specified fleet
stop_image_builder Stops the specified image builder
tag_resource Adds or overwrites one or more tags for the specified AppStream 2
untag_resource Disassociates one or more specified tags from the specified AppStream 2
update_app_block_builder Updates an app block builder
update_application Updates the specified application
update_directory_config Updates the specified Directory Config object in AppStream 2
update_entitlement Updates the specified entitlement
update_fleet Updates the specified fleet
update_image_permissions Adds or updates permissions for the specified private image
update_stack Updates the specified fields for the specified stack
update_theme_for_stack Updates custom branding that customizes the appearance of the streaming application catalog page

Examples

## Not run: 
svc <- appstream()
svc$associate_app_block_builder_app_block(
  Foo = 123
)

## End(Not run)

Amazon Interactive Video Service Chat

Description

Introduction

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.

This document describes HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.

Notes on terminology:

  • You create service applications using the Amazon IVS Chat API. We refer to these as applications.

  • You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.

Resources

The following resources are part of Amazon IVS Chat:

  • LoggingConfiguration — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.

  • Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS Chat API has these tag-related endpoints: tag_resource, untag_resource, and list_tags_for_resource. The following resource supports tagging: Room.

At most 50 tags can be applied to a resource.

API Access Security

Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:

  • Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.

  • Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.

Users (viewers) connect to a room using secure access tokens that you create using the create_chat_token endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.

Signing API Requests

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.

You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.

For more information:

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.

Usage

ivschat(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- ivschat(
  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"
)

Operations

create_chat_token Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room
create_logging_configuration Creates a logging configuration that allows clients to store and record sent messages
create_room Creates a room that allows clients to connect and pass messages
delete_logging_configuration Deletes the specified logging configuration
delete_message Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history
delete_room Deletes the specified room
disconnect_user Disconnects all connections using a specified user ID from a room
get_logging_configuration Gets the specified logging configuration
get_room Gets the specified room
list_logging_configurations Gets summary information about all your logging configurations in the AWS region where the API request is processed
list_rooms Gets summary information about all your rooms in the AWS region where the API request is processed
list_tags_for_resource Gets information about AWS tags for the specified ARN
send_event Sends an event to a room
tag_resource Adds or updates tags for the AWS resource with the specified ARN
untag_resource Removes tags from the resource with the specified ARN
update_logging_configuration Updates a specified logging configuration
update_room Updates a room’s configuration

Examples

## Not run: 
svc <- ivschat()
svc$create_chat_token(
  Foo = 123
)

## End(Not run)

AmazonNimbleStudio

Description

Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.

Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.

Usage

nimblestudio(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- nimblestudio(
  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"
)

Operations

accept_eulas Accept EULAs
create_launch_profile Create a launch profile
create_streaming_image Creates a streaming image resource in a studio
create_streaming_session Creates a streaming session in a studio
create_streaming_session_stream Creates a streaming session stream for a streaming session
create_studio Create a new studio
create_studio_component Creates a studio component resource
delete_launch_profile Permanently delete a launch profile
delete_launch_profile_member Delete a user from launch profile membership
delete_streaming_image Delete streaming image
delete_streaming_session Deletes streaming session resource
delete_studio Delete a studio resource
delete_studio_component Deletes a studio component resource
delete_studio_member Delete a user from studio membership
get_eula Get EULA
get_launch_profile Get a launch profile
get_launch_profile_details Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile
get_launch_profile_initialization Get a launch profile initialization
get_launch_profile_member Get a user persona in launch profile membership
get_streaming_image Get streaming image
get_streaming_session Gets StreamingSession resource
get_streaming_session_backup Gets StreamingSessionBackup resource
get_streaming_session_stream Gets a StreamingSessionStream for a streaming session
get_studio Get a studio resource
get_studio_component Gets a studio component resource
get_studio_member Get a user's membership in a studio
list_eula_acceptances List EULA acceptances
list_eulas List EULAs
list_launch_profile_members Get all users in a given launch profile membership
list_launch_profiles List all the launch profiles a studio
list_streaming_images List the streaming image resources available to this studio
list_streaming_session_backups Lists the backups of a streaming session in a studio
list_streaming_sessions Lists the streaming sessions in a studio
list_studio_components Lists the StudioComponents in a studio
list_studio_members Get all users in a given studio membership
list_studios List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region
list_tags_for_resource Gets the tags for a resource, given its Amazon Resource Names (ARN)
put_launch_profile_members Add/update users with given persona to launch profile membership
put_studio_members Add/update users with given persona to studio membership
start_streaming_session Transitions sessions from the STOPPED state into the READY state
start_studio_sso_configuration_repair Repairs the IAM Identity Center configuration for a given studio
stop_streaming_session Transitions sessions from the READY state into the STOPPED state
tag_resource Creates tags for a resource, given its ARN
untag_resource Deletes the tags for a resource
update_launch_profile Update a launch profile
update_launch_profile_member Update a user persona in launch profile membership
update_streaming_image Update streaming image
update_studio Update a Studio resource
update_studio_component Updates a studio component resource

Examples

## Not run: 
svc <- nimblestudio()
svc$accept_eulas(
  Foo = 123
)

## End(Not run)

Amazon WorkDocs

Description

The Amazon WorkDocs API is designed for the following use cases:

  • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

  • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

  • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the Amazon Web Services SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions:

  • ⁠READ (Get*)⁠

  • ⁠WRITE (Activate*, Add*, Create*, Deactivate*, Initiate*, Update*)⁠

  • ⁠LIST (Describe*)⁠

  • ⁠DELETE*, CANCEL⁠

For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing.

Usage

workdocs(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- workdocs(
  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"
)

Operations

abort_document_version_upload Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload
activate_user Activates the specified user
add_resource_permissions Creates a set of permissions for the specified folder or document
create_comment Adds a new comment to the specified document version
create_custom_metadata Adds one or more custom properties to the specified resource (a folder, document, or version)
create_folder Creates a folder with the specified name and parent folder
create_labels Adds the specified list of labels to the given resource (a document or folder)
create_notification_subscription Configure Amazon WorkDocs to use Amazon SNS notifications
create_user Creates a user in a Simple AD or Microsoft AD directory
deactivate_user Deactivates the specified user, which revokes the user's access to Amazon WorkDocs
delete_comment Deletes the specified comment from the document version
delete_custom_metadata Deletes custom metadata from the specified resource
delete_document Permanently deletes the specified document and its associated metadata
delete_document_version Deletes a specific version of a document
delete_folder Permanently deletes the specified folder and its contents
delete_folder_contents Deletes the contents of the specified folder
delete_labels Deletes the specified list of labels from a resource
delete_notification_subscription Deletes the specified subscription from the specified organization
delete_user Deletes the specified user from a Simple AD or Microsoft AD directory
describe_activities Describes the user activities in a specified time period
describe_comments List all the comments for the specified document version
describe_document_versions Retrieves the document versions for the specified document
describe_folder_contents Describes the contents of the specified folder, including its documents and subfolders
describe_groups Describes the groups specified by the query
describe_notification_subscriptions Lists the specified notification subscriptions
describe_resource_permissions Describes the permissions of a specified resource
describe_root_folders Describes the current user's special folders; the RootFolder and the RecycleBin
describe_users Describes the specified users
get_current_user Retrieves details of the current user for whom the authentication token was generated
get_document Retrieves details of a document
get_document_path Retrieves the path information (the hierarchy from the root folder) for the requested document
get_document_version Retrieves version metadata for the specified document
get_folder Retrieves the metadata of the specified folder
get_folder_path Retrieves the path information (the hierarchy from the root folder) for the specified folder
get_resources Retrieves a collection of resources, including folders and documents
initiate_document_version_upload Creates a new document object and version object
remove_all_resource_permissions Removes all the permissions from the specified resource
remove_resource_permission Removes the permission for the specified principal from the specified resource
restore_document_versions Recovers a deleted version of an Amazon WorkDocs document
search_resources Searches metadata and the content of folders, documents, document versions, and comments
update_document Updates the specified attributes of a document
update_document_version Changes the status of the document version to ACTIVE
update_folder Updates the specified attributes of the specified folder
update_user Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site

Examples

## Not run: 
svc <- workdocs()
svc$abort_document_version_upload(
  Foo = 123
)

## End(Not run)

Amazon WorkMail

Description

WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The WorkMail API is designed for the following scenarios:

  • Listing and describing organizations

  • Managing users

  • Managing groups

  • Managing resources

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

Usage

workmail(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- workmail(
  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"
)

Operations

associate_delegate_to_resource Adds a member (user or group) to the resource's set of delegates
associate_member_to_group Adds a member (user or group) to the group's set
assume_impersonation_role Assumes an impersonation role for the given WorkMail organization
cancel_mailbox_export_job Cancels a mailbox export job
create_alias Adds an alias to the set of a given member (user or group) of WorkMail
create_availability_configuration Creates an AvailabilityConfiguration for the given WorkMail organization and domain
create_group Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation
create_impersonation_role Creates an impersonation role for the given WorkMail organization
create_mobile_device_access_rule Creates a new mobile device access rule for the specified WorkMail organization
create_organization Creates a new WorkMail organization
create_resource Creates a new WorkMail resource
create_user Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation
delete_access_control_rule Deletes an access control rule for the specified WorkMail organization
delete_alias Remove one or more specified aliases from a set of aliases for a given user
delete_availability_configuration Deletes the AvailabilityConfiguration for the given WorkMail organization and domain
delete_email_monitoring_configuration Deletes the email monitoring configuration for a specified organization
delete_group Deletes a group from WorkMail
delete_impersonation_role Deletes an impersonation role for the given WorkMail organization
delete_mailbox_permissions Deletes permissions granted to a member (user or group)
delete_mobile_device_access_override Deletes the mobile device access override for the given WorkMail organization, user, and device
delete_mobile_device_access_rule Deletes a mobile device access rule for the specified WorkMail organization
delete_organization Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization
delete_resource Deletes the specified resource
delete_retention_policy Deletes the specified retention policy from the specified organization
delete_user Deletes a user from WorkMail and all subsequent systems
deregister_from_work_mail Mark a user, group, or resource as no longer used in WorkMail
deregister_mail_domain Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use
describe_email_monitoring_configuration Describes the current email monitoring configuration for a specified organization
describe_entity Returns basic details about an entity in WorkMail
describe_group Returns the data available for the group
describe_inbound_dmarc_settings Lists the settings in a DMARC policy for a specified organization
describe_mailbox_export_job Describes the current status of a mailbox export job
describe_organization Provides more information regarding a given organization based on its identifier
describe_resource Returns the data available for the resource
describe_user Provides information regarding the user
disassociate_delegate_from_resource Removes a member from the resource's set of delegates
disassociate_member_from_group Removes a member from a group
get_access_control_effect Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation role ID
get_default_retention_policy Gets the default retention policy details for the specified organization
get_impersonation_role Gets the impersonation role details for the given WorkMail organization
get_impersonation_role_effect Tests whether the given impersonation role can impersonate a target user
get_mailbox_details Requests a user's mailbox details for a specified organization and user
get_mail_domain Gets details for a mail domain, including domain records required to configure your domain with recommended security
get_mobile_device_access_effect Simulates the effect of the mobile device access rules for the given attributes of a sample access event
get_mobile_device_access_override Gets the mobile device access override for the given WorkMail organization, user, and device
list_access_control_rules Lists the access control rules for the specified organization
list_aliases Creates a paginated call to list the aliases associated with a given entity
list_availability_configurations List all the AvailabilityConfiguration's for the given WorkMail organization
list_group_members Returns an overview of the members of a group
list_groups Returns summaries of the organization's groups
list_groups_for_entity Returns all the groups to which an entity belongs
list_impersonation_roles Lists all the impersonation roles for the given WorkMail organization
list_mailbox_export_jobs Lists the mailbox export jobs started for the specified organization within the last seven days
list_mailbox_permissions Lists the mailbox permissions associated with a user, group, or resource mailbox
list_mail_domains Lists the mail domains in a given WorkMail organization
list_mobile_device_access_overrides Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device
list_mobile_device_access_rules Lists the mobile device access rules for the specified WorkMail organization
list_organizations Returns summaries of the customer's organizations
list_resource_delegates Lists the delegates associated with a resource
list_resources Returns summaries of the organization's resources
list_tags_for_resource Lists the tags applied to an WorkMail organization resource
list_users Returns summaries of the organization's users
put_access_control_rule Adds a new access control rule for the specified organization
put_email_monitoring_configuration Creates or updates the email monitoring configuration for a specified organization
put_inbound_dmarc_settings Enables or disables a DMARC policy for a given organization
put_mailbox_permissions Sets permissions for a user, group, or resource
put_mobile_device_access_override Creates or updates a mobile device access override for the given WorkMail organization, user, and device
put_retention_policy Puts a retention policy to the specified organization
register_mail_domain Registers a new domain in WorkMail and SES, and configures it for use by WorkMail
register_to_work_mail Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities
reset_password Allows the administrator to reset the password for a user
start_mailbox_export_job Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket
tag_resource Applies the specified tags to the specified WorkMailorganization resource
test_availability_configuration Performs a test on an availability provider to ensure that access is allowed
untag_resource Untags the specified tags from the specified WorkMail organization resource
update_availability_configuration Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain
update_default_mail_domain Updates the default mail domain for an organization
update_group Updates attibutes in a group
update_impersonation_role Updates an impersonation role for the given WorkMail organization
update_mailbox_quota Updates a user's current mailbox quota for a specified organization and user
update_mobile_device_access_rule Updates a mobile device access rule for the specified WorkMail organization
update_primary_email_address Updates the primary email for a user, group, or resource
update_resource Updates data for the resource
update_user Updates data for the user

Examples

## Not run: 
svc <- workmail()
svc$associate_delegate_to_resource(
  Foo = 123
)

## End(Not run)

Amazon WorkMail Message Flow

Description

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

Usage

workmailmessageflow(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- workmailmessageflow(
  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"
)

Operations

get_raw_message_content Retrieves the raw content of an in-transit email message, in MIME format
put_raw_message_content Updates the raw content of an in-transit email message, in MIME format

Examples

## Not run: 
svc <- workmailmessageflow()
svc$get_raw_message_content(
  Foo = 123
)

## End(Not run)

Amazon WorkSpaces

Description

Amazon WorkSpaces Service

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.

Usage

workspaces(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- workspaces(
  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"
)

Operations

accept_account_link_invitation Accepts the account link invitation
associate_connection_alias Associates the specified connection alias with the specified directory to enable cross-Region redirection
associate_ip_groups Associates the specified IP access control group with the specified directory
associate_workspace_application Associates the specified application to the specified WorkSpace
authorize_ip_rules Adds one or more rules to the specified IP access control group
copy_workspace_image Copies the specified image from the specified Region to the current Region
create_account_link_invitation Creates the account link invitation
create_connect_client_add_in Creates a client-add-in for Amazon Connect within a directory
create_connection_alias Creates the specified connection alias for use with cross-Region redirection
create_ip_group Creates an IP access control group
create_standby_workspaces Creates a standby WorkSpace in a secondary Region
create_tags Creates the specified tags for the specified WorkSpaces resource
create_updated_workspace_image Creates a new updated WorkSpace image based on the specified source image
create_workspace_bundle Creates the specified WorkSpace bundle
create_workspace_image Creates a new WorkSpace image from an existing WorkSpace
create_workspaces Creates one or more WorkSpaces
create_workspaces_pool Creates a pool of WorkSpaces
delete_account_link_invitation Deletes the account link invitation
delete_client_branding Deletes customized client branding
delete_connect_client_add_in Deletes a client-add-in for Amazon Connect that is configured within a directory
delete_connection_alias Deletes the specified connection alias
delete_ip_group Deletes the specified IP access control group
delete_tags Deletes the specified tags from the specified WorkSpaces resource
delete_workspace_bundle Deletes the specified WorkSpace bundle
delete_workspace_image Deletes the specified image from your account
deploy_workspace_applications Deploys associated applications to the specified WorkSpace
deregister_workspace_directory Deregisters the specified directory
describe_account Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account
describe_account_modifications Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account
describe_application_associations Describes the associations between the application and the specified associated resources
describe_applications Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners
describe_bundle_associations Describes the associations between the applications and the specified bundle
describe_client_branding Describes the specified client branding
describe_client_properties Retrieves a list that describes one or more specified Amazon WorkSpaces clients
describe_connect_client_add_ins Retrieves a list of Amazon Connect client add-ins that have been created
describe_connection_aliases Retrieves a list that describes the connection aliases used for cross-Region redirection
describe_connection_alias_permissions Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias
describe_image_associations Describes the associations between the applications and the specified image
describe_ip_groups Describes one or more of your IP access control groups
describe_tags Describes the specified tags for the specified WorkSpaces resource
describe_workspace_associations Describes the associations betweens applications and the specified WorkSpace
describe_workspace_bundles Retrieves a list that describes the available WorkSpace bundles
describe_workspace_directories Describes the available directories that are registered with Amazon WorkSpaces
describe_workspace_image_permissions Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image
describe_workspace_images Retrieves a list that describes one or more specified images, if the image identifiers are provided
describe_workspaces Describes the specified WorkSpaces
describe_workspaces_connection_status Describes the connection status of the specified WorkSpaces
describe_workspace_snapshots Describes the snapshots for the specified WorkSpace
describe_workspaces_pools Describes the specified WorkSpaces Pools
describe_workspaces_pool_sessions Retrieves a list that describes the streaming sessions for a specified pool
disassociate_connection_alias Disassociates a connection alias from a directory
disassociate_ip_groups Disassociates the specified IP access control group from the specified directory
disassociate_workspace_application Disassociates the specified application from a WorkSpace
get_account_link Retrieves account link information
import_client_branding Imports client branding
import_workspace_image Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces
list_account_links Lists all account links
list_available_management_cidr_ranges Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL)
migrate_workspace Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume
modify_account Modifies the configuration of Bring Your Own License (BYOL) for the specified account
modify_certificate_based_auth_properties Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces
modify_client_properties Modifies the properties of the specified Amazon WorkSpaces clients
modify_saml_properties Modifies multiple properties related to SAML 2
modify_selfservice_permissions Modifies the self-service WorkSpace management capabilities for your users
modify_streaming_properties Modifies the specified streaming properties
modify_workspace_access_properties Specifies which devices and operating systems users can use to access their WorkSpaces
modify_workspace_creation_properties Modify the default properties used to create WorkSpaces
modify_workspace_properties Modifies the specified WorkSpace properties
modify_workspace_state Sets the state of the specified WorkSpace
reboot_workspaces Reboots the specified WorkSpaces
rebuild_workspaces Rebuilds the specified WorkSpace
register_workspace_directory Registers the specified directory
reject_account_link_invitation Rejects the account link invitation
restore_workspace Restores the specified WorkSpace to its last known healthy state
revoke_ip_rules Removes one or more rules from the specified IP access control group
start_workspaces Starts the specified WorkSpaces
start_workspaces_pool Starts the specified pool
stop_workspaces Stops the specified WorkSpaces
stop_workspaces_pool Stops the specified pool
terminate_workspaces Terminates the specified WorkSpaces
terminate_workspaces_pool Terminates the specified pool
terminate_workspaces_pool_session Terminates the pool session
update_connect_client_add_in Updates a Amazon Connect client add-in
update_connection_alias_permission Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory
update_rules_of_ip_group Replaces the current rules of the specified IP access control group with the specified rules
update_workspace_bundle Updates a WorkSpace bundle with a new image
update_workspace_image_permission Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image
update_workspaces_pool Updates the specified pool

Examples

## Not run: 
svc <- workspaces()
svc$accept_account_link_invitation(
  Foo = 123
)

## End(Not run)

Amazon WorkSpaces Web

Description

Amazon WorkSpaces Secure Browser is a low cost, fully managed WorkSpace built specifically to facilitate secure, web-based workloads. WorkSpaces Secure Browser makes it easy for customers to safely provide their employees with access to internal websites and SaaS web applications without the administrative burden of appliances or specialized client software. WorkSpaces Secure Browser provides simple policy tools tailored for user interactions, while offloading common tasks like capacity management, scaling, and maintaining browser images.

Usage

workspacesweb(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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 <- workspacesweb(
  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"
)

Operations

associate_browser_settings Associates a browser settings resource with a web portal
associate_ip_access_settings Associates an IP access settings resource with a web portal
associate_network_settings Associates a network settings resource with a web portal
associate_trust_store Associates a trust store with a web portal
associate_user_access_logging_settings Associates a user access logging settings resource with a web portal
associate_user_settings Associates a user settings resource with a web portal
create_browser_settings Creates a browser settings resource that can be associated with a web portal
create_identity_provider Creates an identity provider resource that is then associated with a web portal
create_ip_access_settings Creates an IP access settings resource that can be associated with a web portal
create_network_settings Creates a network settings resource that can be associated with a web portal
create_portal Creates a web portal
create_trust_store Creates a trust store that can be associated with a web portal
create_user_access_logging_settings Creates a user access logging settings resource that can be associated with a web portal
create_user_settings Creates a user settings resource that can be associated with a web portal
delete_browser_settings Deletes browser settings
delete_identity_provider Deletes the identity provider
delete_ip_access_settings Deletes IP access settings
delete_network_settings Deletes network settings
delete_portal Deletes a web portal
delete_trust_store Deletes the trust store
delete_user_access_logging_settings Deletes user access logging settings
delete_user_settings Deletes user settings
disassociate_browser_settings Disassociates browser settings from a web portal
disassociate_ip_access_settings Disassociates IP access settings from a web portal
disassociate_network_settings Disassociates network settings from a web portal
disassociate_trust_store Disassociates a trust store from a web portal
disassociate_user_access_logging_settings Disassociates user access logging settings from a web portal
disassociate_user_settings Disassociates user settings from a web portal
get_browser_settings Gets browser settings
get_identity_provider Gets the identity provider
get_ip_access_settings Gets the IP access settings
get_network_settings Gets the network settings
get_portal Gets the web portal
get_portal_service_provider_metadata Gets the service provider metadata
get_trust_store Gets the trust store
get_trust_store_certificate Gets the trust store certificate
get_user_access_logging_settings Gets user access logging settings
get_user_settings Gets user settings
list_browser_settings Retrieves a list of browser settings
list_identity_providers Retrieves a list of identity providers for a specific web portal
list_ip_access_settings Retrieves a list of IP access settings
list_network_settings Retrieves a list of network settings
list_portals Retrieves a list or web portals
list_tags_for_resource Retrieves a list of tags for a resource
list_trust_store_certificates Retrieves a list of trust store certificates
list_trust_stores Retrieves a list of trust stores
list_user_access_logging_settings Retrieves a list of user access logging settings
list_user_settings Retrieves a list of user settings
tag_resource Adds or overwrites one or more tags for the specified resource
untag_resource Removes one or more tags from the specified resource
update_browser_settings Updates browser settings
update_identity_provider Updates the identity provider
update_ip_access_settings Updates IP access settings
update_network_settings Updates network settings
update_portal Updates a web portal
update_trust_store Updates the trust store
update_user_access_logging_settings Updates the user access logging settings
update_user_settings Updates the user settings

Examples

## Not run: 
svc <- workspacesweb()
svc$associate_browser_settings(
  Foo = 123
)

## End(Not run)