Returns information about a list of specified managed workgroups in your account.
Request Syntax
{
"maxResults": number,
"nextToken": "string",
"sourceArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups operations, which returns results in the next page.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 1024.
Required: No
- sourceArn
-
The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.
Type: String
Pattern:
^arn:aws[a-z-]*:glue:[a-z0-9-]+:\d+:(database|catalog)[a-z0-9-:]*(?:/[A-Za-z0-9-_]{1,255})*$Required: No
Response Syntax
{
"managedWorkgroups": [
{
"creationDate": "string",
"managedWorkgroupId": "string",
"managedWorkgroupName": "string",
"sourceArn": "string",
"status": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- managedWorkgroups
-
The returned array of managed workgroups.
Type: Array of ManagedWorkgroupListItem objects
- nextToken
-
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
