List Workforces

sagemaker_list_workforces

R Documentation

Use this operation to list all private and vendor workforces in an Amazon Web Services Region

Description

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

Usage

sagemaker_list_workforces(SortBy, SortOrder, NameContains, NextToken,
  MaxResults)

Arguments

SortBy

Sort workforces using the workforce name or creation date.

SortOrder

Sort workforces in ascending or descending order.

NameContains

A filter you can use to search for workforces using part of the workforce name.

NextToken

A token to resume pagination.

MaxResults

The maximum number of workforces returned in the response.

Value

A list with the following syntax:

list(
  Workforces = list(
    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"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_workforces(
  SortBy = "Name"|"CreateDate",
  SortOrder = "Ascending"|"Descending",
  NameContains = "string",
  NextToken = "string",
  MaxResults = 123
)