DescribeIpRestriction
Provides a summary and status of IP rules.
Request Syntax
GET /accounts/AwsAccountId/ip-restriction HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the IP rules.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"AwsAccountId": "string",
"Enabled": boolean,
"IpRestrictionRuleMap": {
"string" : "string"
},
"RequestId": "string",
"VpcEndpointIdRestrictionRuleMap": {
"string" : "string"
},
"VpcIdRestrictionRuleMap": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status of the request.
The following data is returned in JSON format by the service.
- AwsAccountId
-
The ID of the AWS account that contains the IP rules.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$ - Enabled
-
A value that specifies whether IP rules are turned on.
Type: Boolean
- IpRestrictionRuleMap
-
A map that describes the IP rules with CIDR range and description.
Type: String to string map
Key Pattern:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[1-9]))$Value Length Constraints: Minimum length of 0. Maximum length of 150.
- RequestId
-
The AWS request ID for this operation.
Type: String
- VpcEndpointIdRestrictionRuleMap
-
A map of allowed VPC endpoint IDs and their rule descriptions.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern:
^vpce-[0-9a-z]*$Value Length Constraints: Minimum length of 0. Maximum length of 150.
- VpcIdRestrictionRuleMap
-
A map of allowed VPC IDs and their rule descriptions.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern:
^vpc-[0-9a-z]*$Value Length Constraints: Minimum length of 0. Maximum length of 150.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
