/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace QuickSight { namespace Model { /** */ class StartDashboardSnapshotJobRequest : public QuickSightRequest { public: AWS_QUICKSIGHT_API StartDashboardSnapshotJobRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StartDashboardSnapshotJob"; } AWS_QUICKSIGHT_API Aws::String SerializePayload() const override; /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline const Aws::String& GetAwsAccountId() const{ return m_awsAccountId; } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline bool AwsAccountIdHasBeenSet() const { return m_awsAccountIdHasBeenSet; } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline void SetAwsAccountId(const Aws::String& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = value; } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline void SetAwsAccountId(Aws::String&& value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId = std::move(value); } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline void SetAwsAccountId(const char* value) { m_awsAccountIdHasBeenSet = true; m_awsAccountId.assign(value); } /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline StartDashboardSnapshotJobRequest& WithAwsAccountId(const Aws::String& value) { SetAwsAccountId(value); return *this;} /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline StartDashboardSnapshotJobRequest& WithAwsAccountId(Aws::String&& value) { SetAwsAccountId(std::move(value)); return *this;} /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is * executed in.

*/ inline StartDashboardSnapshotJobRequest& WithAwsAccountId(const char* value) { SetAwsAccountId(value); return *this;} /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline const Aws::String& GetDashboardId() const{ return m_dashboardId; } /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline bool DashboardIdHasBeenSet() const { return m_dashboardIdHasBeenSet; } /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline void SetDashboardId(const Aws::String& value) { m_dashboardIdHasBeenSet = true; m_dashboardId = value; } /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline void SetDashboardId(Aws::String&& value) { m_dashboardIdHasBeenSet = true; m_dashboardId = std::move(value); } /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline void SetDashboardId(const char* value) { m_dashboardIdHasBeenSet = true; m_dashboardId.assign(value); } /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline StartDashboardSnapshotJobRequest& WithDashboardId(const Aws::String& value) { SetDashboardId(value); return *this;} /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline StartDashboardSnapshotJobRequest& WithDashboardId(Aws::String&& value) { SetDashboardId(std::move(value)); return *this;} /** *

The ID of the dashboard that you want to start a snapshot job for.

*/ inline StartDashboardSnapshotJobRequest& WithDashboardId(const char* value) { SetDashboardId(value); return *this;} /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline const Aws::String& GetSnapshotJobId() const{ return m_snapshotJobId; } /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline bool SnapshotJobIdHasBeenSet() const { return m_snapshotJobIdHasBeenSet; } /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline void SetSnapshotJobId(const Aws::String& value) { m_snapshotJobIdHasBeenSet = true; m_snapshotJobId = value; } /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline void SetSnapshotJobId(Aws::String&& value) { m_snapshotJobIdHasBeenSet = true; m_snapshotJobId = std::move(value); } /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline void SetSnapshotJobId(const char* value) { m_snapshotJobIdHasBeenSet = true; m_snapshotJobId.assign(value); } /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline StartDashboardSnapshotJobRequest& WithSnapshotJobId(const Aws::String& value) { SetSnapshotJobId(value); return *this;} /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline StartDashboardSnapshotJobRequest& WithSnapshotJobId(Aws::String&& value) { SetSnapshotJobId(std::move(value)); return *this;} /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard * while the job is running. This ID can be used to poll the status of a job with a * DescribeDashboardSnapshotJob while the job runs. You can reuse this * ID for another job 24 hours after the current job is completed.

*/ inline StartDashboardSnapshotJobRequest& WithSnapshotJobId(const char* value) { SetSnapshotJobId(value); return *this;} /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline const SnapshotUserConfiguration& GetUserConfiguration() const{ return m_userConfiguration; } /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline bool UserConfigurationHasBeenSet() const { return m_userConfigurationHasBeenSet; } /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline void SetUserConfiguration(const SnapshotUserConfiguration& value) { m_userConfigurationHasBeenSet = true; m_userConfiguration = value; } /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline void SetUserConfiguration(SnapshotUserConfiguration&& value) { m_userConfigurationHasBeenSet = true; m_userConfiguration = std::move(value); } /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline StartDashboardSnapshotJobRequest& WithUserConfiguration(const SnapshotUserConfiguration& value) { SetUserConfiguration(value); return *this;} /** *

A structure that contains information about the anonymous users that the * generated snapshot is for. This API will not return information about registered * Amazon QuickSight.

*/ inline StartDashboardSnapshotJobRequest& WithUserConfiguration(SnapshotUserConfiguration&& value) { SetUserConfiguration(std::move(value)); return *this;} /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline const SnapshotConfiguration& GetSnapshotConfiguration() const{ return m_snapshotConfiguration; } /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline bool SnapshotConfigurationHasBeenSet() const { return m_snapshotConfigurationHasBeenSet; } /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline void SetSnapshotConfiguration(const SnapshotConfiguration& value) { m_snapshotConfigurationHasBeenSet = true; m_snapshotConfiguration = value; } /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline void SetSnapshotConfiguration(SnapshotConfiguration&& value) { m_snapshotConfigurationHasBeenSet = true; m_snapshotConfiguration = std::move(value); } /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline StartDashboardSnapshotJobRequest& WithSnapshotConfiguration(const SnapshotConfiguration& value) { SetSnapshotConfiguration(value); return *this;} /** *

A structure that describes the configuration of the dashboard snapshot.

*/ inline StartDashboardSnapshotJobRequest& WithSnapshotConfiguration(SnapshotConfiguration&& value) { SetSnapshotConfiguration(std::move(value)); return *this;} private: Aws::String m_awsAccountId; bool m_awsAccountIdHasBeenSet = false; Aws::String m_dashboardId; bool m_dashboardIdHasBeenSet = false; Aws::String m_snapshotJobId; bool m_snapshotJobIdHasBeenSet = false; SnapshotUserConfiguration m_userConfiguration; bool m_userConfigurationHasBeenSet = false; SnapshotConfiguration m_snapshotConfiguration; bool m_snapshotConfigurationHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws