QuickSight / Client / update_ip_restriction

update_ip_restriction#

QuickSight.Client.update_ip_restriction(**kwargs)#

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

See also: AWS API Documentation

Request Syntax

response = client.update_ip_restriction(
    AwsAccountId='string',
    IpRestrictionRuleMap={
        'string': 'string'
    },
    VpcIdRestrictionRuleMap={
        'string': 'string'
    },
    VpcEndpointIdRestrictionRuleMap={
        'string': 'string'
    },
    Enabled=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • IpRestrictionRuleMap (dict) –

    A map that describes the updated IP rules with CIDR ranges and descriptions.

    • (string) –

      • (string) –

  • VpcIdRestrictionRuleMap (dict) –

    A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

    • (string) –

      • (string) –

  • VpcEndpointIdRestrictionRuleMap (dict) –

    A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

    • (string) –

      • (string) –

  • Enabled (boolean) – A value that specifies whether IP rules are turned on.

Return type:

dict

Returns:

Response Syntax

{
    'AwsAccountId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • AwsAccountId (string) –

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

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.InternalFailureException