AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

describe-refresh-schedule

Description

Provides a summary of a refresh schedule.

See also: AWS API Documentation

Synopsis

  describe-refresh-schedule
--aws-account-id <value>
--data-set-id <value>
--schedule-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--aws-account-id (string)

The Amazon Web Services account ID.

--data-set-id (string)

The ID of the dataset.

--schedule-id (string)

The ID of the refresh schedule.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

RefreshSchedule -> (structure)

The refresh schedule.

ScheduleId -> (string)

An identifier for the refresh schedule.

ScheduleFrequency -> (structure)

The frequency for the refresh schedule.

Interval -> (string)

The interval between scheduled refreshes. Valid values are as follows:

  • MINUTE15 : The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
  • MINUTE30 :The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
  • HOURLY : The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
  • DAILY : The dataset refreshes every day.
  • WEEKLY : The dataset refreshes every week.
  • MONTHLY : The dataset refreshes every month.

RefreshOnDay -> (structure)

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

DayOfWeek -> (string)

The day of the week that you want to schedule a refresh on.

DayOfMonth -> (string)

The day of the month that you want to schedule refresh on.

Timezone -> (string)

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs() .

TimeOfTheDay -> (string)

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

StartAfterDateTime -> (timestamp)

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

RefreshType -> (string)

The type of refresh that a datset undergoes. Valid values are as follows:

  • FULL_REFRESH : A complete refresh of a dataset.
  • INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide .

Arn -> (string)

The Amazon Resource Name (ARN) for the refresh schedule.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Arn -> (string)

The Amazon Resource Name (ARN) for the refresh schedule.