QuickSight / Client / describe_topic_refresh_schedule

describe_topic_refresh_schedule#

QuickSight.Client.describe_topic_refresh_schedule(**kwargs)#

Deletes a topic refresh schedule.

Request Syntax

response = client.describe_topic_refresh_schedule(
    AwsAccountId='string',
    TopicId='string',
    DatasetId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The Amazon Web Services account ID.
TopicId (string) –
[REQUIRED]

The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
DatasetId (string) –
[REQUIRED]

The ID of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'TopicId': 'string',
    'TopicArn': 'string',
    'DatasetArn': '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 of the topic that contains the refresh schedule 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.
- DatasetArn (string) –
  
  The Amazon Resource Name (ARN) 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