AWS API Changes

2021/10/18 - Amazon QuickSight - 2 new 3 updated api methods

Changes AWS QuickSight Service Features - Add IP Restriction UI and public APIs support.

DescribeIpRestriction (new)

Provides a summary and status of IP Rules.

Request Syntax

client.describe_ip_restriction(
    AwsAccountId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

Your AWS account ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- AwsAccountId (string) --
  
  Your AWS account ID.
- IpRestrictionRuleMap (dict) --
  
  Describes the IP rules with CIDR range and description.
  - (string) --
    - (string) --
- Enabled (boolean) --
  
  Whether or not IP rules are enabled.
- RequestId (string) --
  
  The ID of the describe request.
- Status (integer) --
  
  The status of a set of IP restrictions. A successful request returns a 200 status code.

UpdateIpRestriction (new)

Link ¶

Updates content and status of IP Rules.

See also: AWS API Documentation

Request Syntax

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

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

Your AWS account ID.

type IpRestrictionRuleMap

dict

param IpRestrictionRuleMap

Describes updated IP rules.

(string) --
- (string) --

type Enabled

boolean

param Enabled

Whether or not IP rules are enabled.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- AwsAccountId (string) --
  
  Your AWS account ID.
- RequestId (string) --
  
  The ID of the update request.
- Status (integer) --
  
  The status of the updated IP rules. A successful request returns a 200 code.

CreateIngestion (updated)

Link ¶
Changes (request)

{'IngestionType': 'INCREMENTAL_REFRESH | FULL_REFRESH'}

Creates and starts a new SPICE ingestion on a dataset

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

See also: AWS API Documentation

Request Syntax

client.create_ingestion(
    DataSetId='string',
    IngestionId='string',
    AwsAccountId='string',
    IngestionType='INCREMENTAL_REFRESH'|'FULL_REFRESH'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The ID of the dataset used in the ingestion.

type IngestionId

string

param IngestionId

[REQUIRED]

An ID for the ingestion.

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The Amazon Web Services account ID.

type IngestionType

string

param IngestionType

The type of ingestion that you want to create.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'IngestionId': 'string',
    'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) for the data ingestion.
- IngestionId (string) --
  
  An ID for the ingestion.
- IngestionStatus (string) --
  
  The ingestion status.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

DescribeIngestion (updated)

Link ¶
Changes (response)

{'Ingestion': {'ErrorInfo': {'Type': {'CURSOR_NOT_ENABLED',
                                      'ELASTICSEARCH_CURSOR_NOT_ENABLED',
                                      'PERMISSION_NOT_FOUND',
                                      'REFRESH_SUPPRESSED_BY_EDIT'}},
               'RowInfo': {'TotalRowsInDataset': 'long'}}}

Describes a SPICE ingestion.

See also: AWS API Documentation

Request Syntax

client.describe_ingestion(
    AwsAccountId='string',
    DataSetId='string',
    IngestionId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The Amazon Web Services account ID.

type DataSetId

string

param DataSetId

[REQUIRED]

The ID of the dataset used in the ingestion.

type IngestionId

string

param IngestionId

[REQUIRED]

An ID for the ingestion.

rtype

dict

returns

Response Syntax

{
    'Ingestion': {
        'Arn': 'string',
        'IngestionId': 'string',
        'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
        'ErrorInfo': {
            'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED',
            'Message': 'string'
        },
        'RowInfo': {
            'RowsIngested': 123,
            'RowsDropped': 123,
            'TotalRowsInDataset': 123
        },
        'QueueInfo': {
            'WaitingOnIngestion': 'string',
            'QueuedIngestion': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'IngestionTimeInSeconds': 123,
        'IngestionSizeInBytes': 123,
        'RequestSource': 'MANUAL'|'SCHEDULED',
        'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Ingestion (dict) --
  
  Information about the ingestion.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the resource.
  - IngestionId (string) --
    
    Ingestion ID.
  - IngestionStatus (string) --
    
    Ingestion status.
  - ErrorInfo (dict) --
    
    Error information for this ingestion.
    - Type (string) --
      
      Error type.
    - Message (string) --
      
      Error message.
  - RowInfo (dict) --
    
    Information about rows for a data set SPICE ingestion.
    - RowsIngested (integer) --
      
      The number of rows that were ingested.
    - RowsDropped (integer) --
      
      The number of rows that were not ingested.
    - TotalRowsInDataset (integer) --
      
      The total number of rows in the dataset.
  - QueueInfo (dict) --
    
    Information about a queued dataset SPICE ingestion.
    - WaitingOnIngestion (string) --
      
      The ID of the queued ingestion.
    - QueuedIngestion (string) --
      
      The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
  - CreatedTime (datetime) --
    
    The time that this ingestion started.
  - IngestionTimeInSeconds (integer) --
    
    The time that this ingestion took, measured in seconds.
  - IngestionSizeInBytes (integer) --
    
    The size of the data ingested, in bytes.
  - RequestSource (string) --
    
    Event source for this ingestion.
  - RequestType (string) --
    
    Type of this ingestion.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

ListIngestions (updated)

Link ¶
Changes (response)

{'Ingestions': {'ErrorInfo': {'Type': {'CURSOR_NOT_ENABLED',
                                       'ELASTICSEARCH_CURSOR_NOT_ENABLED',
                                       'PERMISSION_NOT_FOUND',
                                       'REFRESH_SUPPRESSED_BY_EDIT'}},
                'RowInfo': {'TotalRowsInDataset': 'long'}}}

Lists the history of SPICE ingestions for a dataset.

See also: AWS API Documentation

Request Syntax

client.list_ingestions(
    DataSetId='string',
    NextToken='string',
    AwsAccountId='string',
    MaxResults=123
)

type DataSetId

string

param DataSetId

[REQUIRED]

The ID of the dataset used in the ingestion.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The Amazon Web Services account ID.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'Ingestions': [
        {
            'Arn': 'string',
            'IngestionId': 'string',
            'IngestionStatus': 'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED',
            'ErrorInfo': {
                'Type': 'FAILURE_TO_ASSUME_ROLE'|'INGESTION_SUPERSEDED'|'INGESTION_CANCELED'|'DATA_SET_DELETED'|'DATA_SET_NOT_SPICE'|'S3_UPLOADED_FILE_DELETED'|'S3_MANIFEST_ERROR'|'DATA_TOLERANCE_EXCEPTION'|'SPICE_TABLE_NOT_FOUND'|'DATA_SET_SIZE_LIMIT_EXCEEDED'|'ROW_SIZE_LIMIT_EXCEEDED'|'ACCOUNT_CAPACITY_LIMIT_EXCEEDED'|'CUSTOMER_ERROR'|'DATA_SOURCE_NOT_FOUND'|'IAM_ROLE_NOT_AVAILABLE'|'CONNECTION_FAILURE'|'SQL_TABLE_NOT_FOUND'|'PERMISSION_DENIED'|'SSL_CERTIFICATE_VALIDATION_FAILURE'|'OAUTH_TOKEN_FAILURE'|'SOURCE_API_LIMIT_EXCEEDED_FAILURE'|'PASSWORD_AUTHENTICATION_FAILURE'|'SQL_SCHEMA_MISMATCH_ERROR'|'INVALID_DATE_FORMAT'|'INVALID_DATAPREP_SYNTAX'|'SOURCE_RESOURCE_LIMIT_EXCEEDED'|'SQL_INVALID_PARAMETER_VALUE'|'QUERY_TIMEOUT'|'SQL_NUMERIC_OVERFLOW'|'UNRESOLVABLE_HOST'|'UNROUTABLE_HOST'|'SQL_EXCEPTION'|'S3_FILE_INACCESSIBLE'|'IOT_FILE_NOT_FOUND'|'IOT_DATA_SET_FILE_EMPTY'|'INVALID_DATA_SOURCE_CONFIG'|'DATA_SOURCE_AUTH_FAILED'|'DATA_SOURCE_CONNECTION_FAILED'|'FAILURE_TO_PROCESS_JSON_FILE'|'INTERNAL_SERVICE_ERROR'|'REFRESH_SUPPRESSED_BY_EDIT'|'PERMISSION_NOT_FOUND'|'ELASTICSEARCH_CURSOR_NOT_ENABLED'|'CURSOR_NOT_ENABLED',
                'Message': 'string'
            },
            'RowInfo': {
                'RowsIngested': 123,
                'RowsDropped': 123,
                'TotalRowsInDataset': 123
            },
            'QueueInfo': {
                'WaitingOnIngestion': 'string',
                'QueuedIngestion': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1),
            'IngestionTimeInSeconds': 123,
            'IngestionSizeInBytes': 123,
            'RequestSource': 'MANUAL'|'SCHEDULED',
            'RequestType': 'INITIAL_INGESTION'|'EDIT'|'INCREMENTAL_REFRESH'|'FULL_REFRESH'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Ingestions (list) --
  
  A list of the ingestions.
  - (dict) --
    
    Information about the SPICE ingestion for a dataset.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the resource.
    - IngestionId (string) --
      
      Ingestion ID.
    - IngestionStatus (string) --
      
      Ingestion status.
    - ErrorInfo (dict) --
      
      Error information for this ingestion.
      - Type (string) --
        
        Error type.
      - Message (string) --
        
        Error message.
    - RowInfo (dict) --
      
      Information about rows for a data set SPICE ingestion.
      - RowsIngested (integer) --
        
        The number of rows that were ingested.
      - RowsDropped (integer) --
        
        The number of rows that were not ingested.
      - TotalRowsInDataset (integer) --
        
        The total number of rows in the dataset.
    - QueueInfo (dict) --
      
      Information about a queued dataset SPICE ingestion.
      - WaitingOnIngestion (string) --
        
        The ID of the queued ingestion.
      - QueuedIngestion (string) --
        
        The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
    - CreatedTime (datetime) --
      
      The time that this ingestion started.
    - IngestionTimeInSeconds (integer) --
      
      The time that this ingestion took, measured in seconds.
    - IngestionSizeInBytes (integer) --
      
      The size of the data ingested, in bytes.
    - RequestSource (string) --
      
      Event source for this ingestion.
    - RequestType (string) --
      
      Type of this ingestion.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.