QuickSight / Client / list_topic_refresh_schedules

list_topic_refresh_schedules#

QuickSight.Client.list_topic_refresh_schedules(**kwargs)#

Lists all of the refresh schedules for a topic.

Request Syntax

response = client.list_topic_refresh_schedules(
    AwsAccountId='string',
    TopicId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.
TopicId (string) –
[REQUIRED]

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Return type:

dict

Returns:

Response Syntax

{
    'TopicId': 'string',
    'TopicArn': 'string',
    'RefreshSchedules': [
        {
            'DatasetId': 'string',
            'DatasetArn': 'string',
            'DatasetName': 'string',
            'RefreshSchedule': {
                'IsEnabled': True|False,
                'BasedOnSpiceSchedule': True|False,
                'StartingAt': datetime(2015, 1, 1),
                'Timezone': 'string',
                'RepeatAt': 'string',
                'TopicScheduleType': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'
            }
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) –
- TopicId (string) –
  
  The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
- TopicArn (string) –
  
  The Amazon Resource Name (ARN) of the topic.
- RefreshSchedules (list) –
  
  The list of topic refresh schedules.
  - (dict) –
    
    A summary of the refresh schedule details for a dataset.
    - DatasetId (string) –
      
      The ID of the dataset.
    - DatasetArn (string) –
      
      The Amazon Resource Name (ARN) of the dataset.
    - DatasetName (string) –
      
      The name of the dataset.
    - RefreshSchedule (dict) –
      
      The definition of a refresh schedule.
      - IsEnabled (boolean) –
        
        A Boolean value that controls whether to schedule is enabled.
      - BasedOnSpiceSchedule (boolean) –
        
        A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.
      - StartingAt (datetime) –
        
        The starting date and time for the refresh schedule.
      - Timezone (string) –
        
        The timezone that you want the refresh schedule to use.
      - RepeatAt (string) –
        
        The time of day when the refresh should run, for example, Monday-Sunday.
      - TopicScheduleType (string) –
        
        The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ResourceExistsException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InternalFailureException