Describe Workforce

sagemaker_describe_workforce

R Documentation

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs)

Description

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

Usage

sagemaker_describe_workforce(WorkforceName)

Arguments

WorkforceName

[required] The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Value

A list with the following syntax:

list(
  Workforce = list(
    WorkforceName = "string",
    WorkforceArn = "string",
    LastUpdatedDate = as.POSIXct(
      "2015-01-01"
    ),
    SourceIpConfig = list(
      Cidrs = list(
        "string"
      )
    ),
    SubDomain = "string",
    CognitoConfig = list(
      UserPool = "string",
      ClientId = "string"
    ),
    OidcConfig = list(
      ClientId = "string",
      Issuer = "string",
      AuthorizationEndpoint = "string",
      TokenEndpoint = "string",
      UserInfoEndpoint = "string",
      LogoutEndpoint = "string",
      JwksUri = "string",
      Scope = "string",
      AuthenticationRequestExtraParams = list(
        "string"
      )
    ),
    CreateDate = as.POSIXct(
      "2015-01-01"
    ),
    WorkforceVpcConfig = list(
      VpcId = "string",
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      ),
      VpcEndpointId = "string"
    ),
    Status = "Initializing"|"Updating"|"Deleting"|"Failed"|"Active",
    FailureReason = "string"
  )
)

Request syntax

svc$describe_workforce(
  WorkforceName = "string"
)