Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeIpGroups

Describes one or more of your IP access control groups.

Request Syntax


{
   "GroupIds": [ "string" ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

GroupIds

The identifiers of one or more IP access control groups.

Type: Array of strings

Pattern: wsipg-[0-9a-z]{8,63}$

Required: No

MaxResults

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Result": [ 
      { 
         "groupDesc": "string",
         "groupId": "string",
         "groupName": "string",
         "userRules": [ 
            { 
               "ipRule": "string",
               "ruleDesc": "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.

NextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Result

Information about the IP access control groups.

Type: Array of WorkspacesIpGroup objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400