NAME

Paws::Quicksight::CreateDashboard - Arguments for method CreateDashboard on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method CreateDashboard on the Amazon QuickSight service. Use the attributes of this class as arguments to method CreateDashboard.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDashboard.

SYNOPSIS

my $quicksight = Paws->service('Quicksight');
my $CreateDashboardResponse = $quicksight->CreateDashboard(
  AwsAccountId => 'MyAwsAccountId',
  DashboardId  => 'MyRestrictiveResourceId',
  Name         => 'MyDashboardName',
  SourceEntity => {
    SourceTemplate => {
      Arn               => 'MyArn',
      DataSetReferences => [
        {
          DataSetArn         => 'MyArn',
          DataSetPlaceholder => 'MyNonEmptyString',

        },
        ...
      ],    # min: 1

    },    # OPTIONAL
  },
  DashboardPublishOptions => {
    AdHocFilteringOption => {
      AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL
    },    # OPTIONAL
    ExportToCSVOption => {
      AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL
    },    # OPTIONAL
    SheetControlsOption => {
      VisibilityState => 'EXPANDED', # values: EXPANDED, COLLAPSED; OPTIONAL
    },    # OPTIONAL
  },    # OPTIONAL
  Parameters => {
    DateTimeParameters => [
      {
        Name   => 'MyNonEmptyString',
        Values => [ '1970-01-01T01:00:00', ... ],

      },
      ...
    ],    # max: 100; OPTIONAL
    DecimalParameters => [
      {
        Name   => 'MyNonEmptyString',
        Values => [ 1, ... ],

      },
      ...
    ],    # max: 100; OPTIONAL
    IntegerParameters => [
      {
        Name   => 'MyNonEmptyString',
        Values => [ 1, ... ],

      },
      ...
    ],    # max: 100; OPTIONAL
    StringParameters => [
      {
        Name   => 'MyNonEmptyString',
        Values => [ 'MyString', ... ],

      },
      ...
    ],    # max: 100; OPTIONAL
  },    # OPTIONAL
  Permissions => [
    {
      Actions   => [ 'MyString', ... ],    # min: 1, max: 16
      Principal => 'MyPrincipal',          # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
  ThemeArn           => 'MyArn',                   # OPTIONAL
  VersionDescription => 'MyVersionDescription',    # OPTIONAL
);

# Results:
my $Arn            = $CreateDashboardResponse->Arn;
my $CreationStatus = $CreateDashboardResponse->CreationStatus;
my $DashboardId    = $CreateDashboardResponse->DashboardId;
my $RequestId      = $CreateDashboardResponse->RequestId;
my $Status         = $CreateDashboardResponse->Status;
my $VersionArn     = $CreateDashboardResponse->VersionArn;

# Returns a L<Paws::Quicksight::CreateDashboardResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateDashboard

ATTRIBUTES

REQUIRED AwsAccountId => Str

The ID of the AWS account where you want to create the dashboard.

REQUIRED DashboardId => Str

The ID for the dashboard, also added to the IAM policy.

DashboardPublishOptions => Paws::Quicksight::DashboardPublishOptions

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

REQUIRED Name => Str

The display name of the dashboard.

Parameters => Paws::Quicksight::Parameters

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

REQUIRED SourceEntity => Paws::Quicksight::DashboardSourceEntity

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Tags => ArrayRef[Paws::Quicksight::Tag]

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

ThemeArn => Str

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

VersionDescription => Str

A description for the first version of the dashboard being created.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDashboard in Paws::Quicksight

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws