Get Launch Profile Details

nimblestudio_get_launch_profile_details

R Documentation

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile

Description

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

Usage

nimblestudio_get_launch_profile_details(launchProfileId, studioId)

Arguments

launchProfileId

[required] The ID of the launch profile used to control access from the streaming session.

studioId

[required] The studio ID.

Value

A list with the following syntax:

list(
  launchProfile = list(
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    createdBy = "string",
    description = "string",
    ec2SubnetIds = list(
      "string"
    ),
    launchProfileId = "string",
    launchProfileProtocolVersions = list(
      "string"
    ),
    name = "string",
    state = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED",
    statusCode = "LAUNCH_PROFILE_CREATED"|"LAUNCH_PROFILE_UPDATED"|"LAUNCH_PROFILE_DELETED"|"LAUNCH_PROFILE_CREATE_IN_PROGRESS"|"LAUNCH_PROFILE_UPDATE_IN_PROGRESS"|"LAUNCH_PROFILE_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"STREAMING_IMAGE_NOT_FOUND"|"STREAMING_IMAGE_NOT_READY"|"LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"|"ENCRYPTION_KEY_ACCESS_DENIED"|"ENCRYPTION_KEY_NOT_FOUND"|"INVALID_SUBNETS_PROVIDED"|"INVALID_INSTANCE_TYPES_PROVIDED"|"INVALID_SUBNETS_COMBINATION",
    statusMessage = "string",
    streamConfiguration = list(
      automaticTerminationMode = "DEACTIVATED"|"ACTIVATED",
      clipboardMode = "ENABLED"|"DISABLED",
      ec2InstanceTypes = list(
        "g4dn.xlarge"|"g4dn.2xlarge"|"g4dn.4xlarge"|"g4dn.8xlarge"|"g4dn.12xlarge"|"g4dn.16xlarge"|"g3.4xlarge"|"g3s.xlarge"|"g5.xlarge"|"g5.2xlarge"|"g5.4xlarge"|"g5.8xlarge"|"g5.16xlarge"
      ),
      maxSessionLengthInMinutes = 123,
      maxStoppedSessionLengthInMinutes = 123,
      sessionBackup = list(
        maxBackupsToRetain = 123,
        mode = "AUTOMATIC"|"DEACTIVATED"
      ),
      sessionPersistenceMode = "DEACTIVATED"|"ACTIVATED",
      sessionStorage = list(
        mode = list(
          "UPLOAD"
        ),
        root = list(
          linux = "string",
          windows = "string"
        )
      ),
      streamingImageIds = list(
        "string"
      ),
      volumeConfiguration = list(
        iops = 123,
        size = 123,
        throughput = 123
      )
    ),
    studioComponentIds = list(
      "string"
    ),
    tags = list(
      "string"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedBy = "string",
    validationResults = list(
      list(
        state = "VALIDATION_NOT_STARTED"|"VALIDATION_IN_PROGRESS"|"VALIDATION_SUCCESS"|"VALIDATION_FAILED"|"VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
        statusCode = "VALIDATION_NOT_STARTED"|"VALIDATION_IN_PROGRESS"|"VALIDATION_SUCCESS"|"VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"|"VALIDATION_FAILED_SUBNET_NOT_FOUND"|"VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"|"VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"|"VALIDATION_FAILED_UNAUTHORIZED"|"VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
        statusMessage = "string",
        type = "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"|"VALIDATE_SUBNET_ASSOCIATION"|"VALIDATE_NETWORK_ACL_ASSOCIATION"|"VALIDATE_SECURITY_GROUP_ASSOCIATION"
      )
    )
  ),
  streamingImages = list(
    list(
      arn = "string",
      description = "string",
      ec2ImageId = "string",
      encryptionConfiguration = list(
        keyArn = "string",
        keyType = "CUSTOMER_MANAGED_KEY"
      ),
      eulaIds = list(
        "string"
      ),
      name = "string",
      owner = "string",
      platform = "string",
      state = "CREATE_IN_PROGRESS"|"READY"|"DELETE_IN_PROGRESS"|"DELETED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"CREATE_FAILED"|"DELETE_FAILED",
      statusCode = "STREAMING_IMAGE_CREATE_IN_PROGRESS"|"STREAMING_IMAGE_READY"|"STREAMING_IMAGE_DELETE_IN_PROGRESS"|"STREAMING_IMAGE_DELETED"|"STREAMING_IMAGE_UPDATE_IN_PROGRESS"|"INTERNAL_ERROR"|"ACCESS_DENIED",
      statusMessage = "string",
      streamingImageId = "string",
      tags = list(
        "string"
      )
    )
  ),
  studioComponentSummaries = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      createdBy = "string",
      description = "string",
      name = "string",
      studioComponentId = "string",
      subtype = "AWS_MANAGED_MICROSOFT_AD"|"AMAZON_FSX_FOR_WINDOWS"|"AMAZON_FSX_FOR_LUSTRE"|"CUSTOM",
      type = "ACTIVE_DIRECTORY"|"SHARED_FILE_SYSTEM"|"COMPUTE_FARM"|"LICENSE_SERVICE"|"CUSTOM",
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedBy = "string"
    )
  )
)

Request syntax

svc$get_launch_profile_details(
  launchProfileId = "string",
  studioId = "string"
)