Amazon QuickSight

2024/03/28 - Amazon QuickSight - 2 updated api methods

Changes  Amazon QuickSight: Adds support for setting up VPC Endpoint restrictions for accessing QuickSight Website.

DescribeIpRestriction (updated) Link ¶
Changes (response) 
{'VpcEndpointIdRestrictionRuleMap': {'string': 'string'},
 'VpcIdRestrictionRuleMap': {'string': 'string'}}

Provides a summary and status of IP rules.

See also: AWS API Documentation

Request Syntax

client.describe_ip_restriction(
    AwsAccountId='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'AwsAccountId': 'string',
    'IpRestrictionRuleMap': {
        'string': 'string'
    },
    'VpcIdRestrictionRuleMap': {
        'string': 'string'
    },
    'VpcEndpointIdRestrictionRuleMap': {
        '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) --

    • VpcIdRestrictionRuleMap (dict) --

      A map of allowed VPC IDs and their rule descriptions.

      • (string) --

        • (string) --

    • VpcEndpointIdRestrictionRuleMap (dict) --

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

      • (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.

UpdateIpRestriction (updated) Link ¶
Changes (request) 
{'VpcEndpointIdRestrictionRuleMap': {'string': 'string'},
 'VpcIdRestrictionRuleMap': {'string': 'string'}}

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

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

string

param AwsAccountId:

[REQUIRED]

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

type IpRestrictionRuleMap:

dict

param IpRestrictionRuleMap:

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

  • (string) --

    • (string) --

type VpcIdRestrictionRuleMap:

dict

param VpcIdRestrictionRuleMap:

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) --

type VpcEndpointIdRestrictionRuleMap:

dict

param VpcEndpointIdRestrictionRuleMap:

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

  • (string) --

    • (string) --

type Enabled:

boolean

param Enabled:

A value that specifies whether IP rules are turned on.

rtype:

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.