Client

nimblestudio

R Documentation

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)