« blib/lib/Paws/Quicksight/CreateTemplateResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/CreateThemeAlias.pm »
| 1 | |||
| 2 | package Paws::Quicksight::CreateTheme; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has BaseThemeId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Configuration => (is => 'ro', isa => 'Paws::Quicksight::ThemeConfiguration', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Permissions => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::ResourcePermission]'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::Tag]'); | ||
| 10 | has ThemeId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ThemeId', required => 1); | ||
| 11 | has VersionDescription => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTheme'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/themes/{ThemeId}'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::CreateThemeResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Quicksight::CreateTheme - Arguments for method CreateTheme on L<Paws::Quicksight> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateTheme on the | ||
| 30 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateTheme. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTheme. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $quicksight = Paws->service('Quicksight'); | ||
| 38 | my $CreateThemeResponse = $quicksight->CreateTheme( | ||
| 39 | AwsAccountId => 'MyAwsAccountId', | ||
| 40 | BaseThemeId => 'MyRestrictiveResourceId', | ||
| 41 | Configuration => { | ||
| 42 | DataColorPalette => { | ||
| 43 | Colors => [ 'MyHexColor', ... ], # max: 100; OPTIONAL | ||
| 44 | EmptyFillColor => 'MyHexColor', | ||
| 45 | MinMaxGradient => [ 'MyHexColor', ... ], # max: 100; OPTIONAL | ||
| 46 | }, # OPTIONAL | ||
| 47 | Sheet => { | ||
| 48 | Tile => { | ||
| 49 | Border => { | ||
| 50 | Show => 1, # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | TileLayout => { | ||
| 54 | Gutter => { | ||
| 55 | Show => 1, # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | Margin => { | ||
| 58 | Show => 1, # OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | UIColorPalette => { | ||
| 63 | Accent => 'MyHexColor', | ||
| 64 | AccentForeground => 'MyHexColor', | ||
| 65 | Danger => 'MyHexColor', | ||
| 66 | DangerForeground => 'MyHexColor', | ||
| 67 | Dimension => 'MyHexColor', | ||
| 68 | DimensionForeground => 'MyHexColor', | ||
| 69 | Measure => 'MyHexColor', | ||
| 70 | MeasureForeground => 'MyHexColor', | ||
| 71 | PrimaryBackground => 'MyHexColor', | ||
| 72 | PrimaryForeground => 'MyHexColor', | ||
| 73 | SecondaryBackground => 'MyHexColor', | ||
| 74 | SecondaryForeground => 'MyHexColor', | ||
| 75 | Success => 'MyHexColor', | ||
| 76 | SuccessForeground => 'MyHexColor', | ||
| 77 | Warning => 'MyHexColor', | ||
| 78 | WarningForeground => 'MyHexColor', | ||
| 79 | }, # OPTIONAL | ||
| 80 | }, | ||
| 81 | Name => 'MyThemeName', | ||
| 82 | ThemeId => 'MyRestrictiveResourceId', | ||
| 83 | Permissions => [ | ||
| 84 | { | ||
| 85 | Actions => [ 'MyString', ... ], # min: 1, max: 16 | ||
| 86 | Principal => 'MyPrincipal', # min: 1, max: 256 | ||
| 87 | |||
| 88 | }, | ||
| 89 | ... | ||
| 90 | ], # OPTIONAL | ||
| 91 | Tags => [ | ||
| 92 | { | ||
| 93 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 94 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 95 | |||
| 96 | }, | ||
| 97 | ... | ||
| 98 | ], # OPTIONAL | ||
| 99 | VersionDescription => 'MyVersionDescription', # OPTIONAL | ||
| 100 | ); | ||
| 101 | |||
| 102 | # Results: | ||
| 103 | my $Arn = $CreateThemeResponse->Arn; | ||
| 104 | my $CreationStatus = $CreateThemeResponse->CreationStatus; | ||
| 105 | my $RequestId = $CreateThemeResponse->RequestId; | ||
| 106 | my $Status = $CreateThemeResponse->Status; | ||
| 107 | my $ThemeId = $CreateThemeResponse->ThemeId; | ||
| 108 | my $VersionArn = $CreateThemeResponse->VersionArn; | ||
| 109 | |||
| 110 | # Returns a L<Paws::Quicksight::CreateThemeResponse> object. | ||
| 111 | |||
| 112 | 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. | ||
| 113 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateTheme> | ||
| 114 | |||
| 115 | =head1 ATTRIBUTES | ||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 119 | |||
| 120 | The ID of the AWS account where you want to store the new theme. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> BaseThemeId => Str | ||
| 125 | |||
| 126 | The ID of the theme that a custom theme will inherit from. All themes | ||
| 127 | inherit from one of the starting themes defined by Amazon QuickSight. | ||
| 128 | For a list of the starting themes, use C<ListThemes> or choose | ||
| 129 | B<Themes> from within a QuickSight analysis. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> Configuration => L<Paws::Quicksight::ThemeConfiguration> | ||
| 134 | |||
| 135 | The theme configuration, which contains the theme display properties. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> Name => Str | ||
| 140 | |||
| 141 | A display name for the theme. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 Permissions => ArrayRef[L<Paws::Quicksight::ResourcePermission>] | ||
| 146 | |||
| 147 | A valid grouping of resource permissions to apply to the new theme. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 Tags => ArrayRef[L<Paws::Quicksight::Tag>] | ||
| 152 | |||
| 153 | A map of the key-value pairs for the resource tag or tags that you want | ||
| 154 | to add to the resource. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> ThemeId => Str | ||
| 159 | |||
| 160 | An ID for the theme that you want to create. The theme ID is unique per | ||
| 161 | AWS Region in each AWS account. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 VersionDescription => Str | ||
| 166 | |||
| 167 | A description of the first version of the theme that you're creating. | ||
| 168 | Every time C<UpdateTheme> is called, a new version is created. Each | ||
| 169 | version of the theme has a description of the version in the | ||
| 170 | C<VersionDescription> field. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, documenting arguments for method CreateTheme in L<Paws::Quicksight> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |