describe_ip_restriction

QuickSight.Client.describe_ip_restriction(**kwargs)

Provides a summary and status of IP rules.

See also: AWS API Documentation

Request Syntax

response = client.describe_ip_restriction(
    AwsAccountId='string'
)

Parameters

AwsAccountId (string) --

[REQUIRED]

The ID of the Amazon Web Services account that contains the IP rules.

Return type

dict

Returns

Response Syntax

{
    'AwsAccountId': 'string',
    'IpRestrictionRuleMap': {
        'string': 'string'
    },
    'Enabled': True|False,
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) --
  • AwsAccountId (string) --

    The ID of the Amazon Web Services account that contains the IP rules.

  • IpRestrictionRuleMap (dict) --

    A map that describes the IP rules with CIDR range and description.

    • (string) --
      • (string) --
  • Enabled (boolean) --

    A value that specifies whether IP rules are turned on.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

  • Status (integer) --

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException
• QuickSight.Client.exceptions.InvalidParameterValueException
• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.InternalFailureException