aws-sdk 2.1443.0 → 2.1444.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -1
- package/README.md +1 -1
- package/apis/glue-2017-03-31.min.json +153 -137
- package/apis/mediaconvert-2017-08-29.min.json +134 -96
- package/apis/medialive-2017-10-14.min.json +237 -225
- package/apis/quicksight-2018-04-01.min.json +737 -706
- package/apis/quicksight-2018-04-01.paginators.json +30 -0
- package/apis/rds-2014-10-31.paginators.json +6 -0
- package/apis/s3-2006-03-01.examples.json +131 -131
- package/clients/ec2.d.ts +1 -1
- package/clients/glue.d.ts +25 -0
- package/clients/mediaconvert.d.ts +52 -6
- package/clients/medialive.d.ts +19 -0
- package/clients/mediatailor.d.ts +2 -2
- package/clients/quicksight.d.ts +89 -27
- package/clients/rds.d.ts +2 -2
- package/clients/verifiedpermissions.d.ts +18 -18
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +7 -7
- package/dist/aws-sdk.js +9 -3
- package/dist/aws-sdk.min.js +29 -29
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/quicksight.d.ts
CHANGED
@@ -1044,11 +1044,11 @@ declare class QuickSight extends Service {
|
|
1044
1044
|
*/
|
1045
1045
|
startAssetBundleImportJob(callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleImportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleImportJobResponse, AWSError>;
|
1046
1046
|
/**
|
1047
|
-
* Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call. 1 paginated PDF 5 CSVs Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
|
1047
|
+
* Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call. 1 paginated PDF 1 Excel workbook 5 CSVs Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
|
1048
1048
|
*/
|
1049
1049
|
startDashboardSnapshotJob(params: QuickSight.Types.StartDashboardSnapshotJobRequest, callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
|
1050
1050
|
/**
|
1051
|
-
* Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call. 1 paginated PDF 5 CSVs Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
|
1051
|
+
* Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call. 1 paginated PDF 1 Excel workbook 5 CSVs Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
|
1052
1052
|
*/
|
1053
1053
|
startDashboardSnapshotJob(callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
|
1054
1054
|
/**
|
@@ -1418,6 +1418,8 @@ declare namespace QuickSight {
|
|
1418
1418
|
}
|
1419
1419
|
export type AggregationSortConfigurationList = AggregationSortConfiguration[];
|
1420
1420
|
export type AliasName = string;
|
1421
|
+
export interface AllSheetsFilterScopeConfiguration {
|
1422
|
+
}
|
1421
1423
|
export interface AmazonElasticsearchParameters {
|
1422
1424
|
/**
|
1423
1425
|
* The OpenSearch domain.
|
@@ -3709,11 +3711,11 @@ declare namespace QuickSight {
|
|
3709
3711
|
*/
|
3710
3712
|
FolderId: RestrictiveResourceId;
|
3711
3713
|
/**
|
3712
|
-
* The ID of the asset
|
3714
|
+
* The ID of the asset that you want to add to the folder.
|
3713
3715
|
*/
|
3714
3716
|
MemberId: RestrictiveResourceId;
|
3715
3717
|
/**
|
3716
|
-
* The type of the
|
3718
|
+
* The member type of the asset that you want to add to a folder.
|
3717
3719
|
*/
|
3718
3720
|
MemberType: MemberType;
|
3719
3721
|
}
|
@@ -3760,6 +3762,10 @@ declare namespace QuickSight {
|
|
3760
3762
|
* Tags for the folder.
|
3761
3763
|
*/
|
3762
3764
|
Tags?: TagList;
|
3765
|
+
/**
|
3766
|
+
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.
|
3767
|
+
*/
|
3768
|
+
SharingModel?: SharingModel;
|
3763
3769
|
}
|
3764
3770
|
export interface CreateFolderResponse {
|
3765
3771
|
/**
|
@@ -6044,11 +6050,11 @@ declare namespace QuickSight {
|
|
6044
6050
|
*/
|
6045
6051
|
FolderId: RestrictiveResourceId;
|
6046
6052
|
/**
|
6047
|
-
* The ID of the asset
|
6053
|
+
* The ID of the asset that you want to delete.
|
6048
6054
|
*/
|
6049
6055
|
MemberId: RestrictiveResourceId;
|
6050
6056
|
/**
|
6051
|
-
* The type of the
|
6057
|
+
* The member type of the asset that you want to delete from a folder.
|
6052
6058
|
*/
|
6053
6059
|
MemberType: MemberType;
|
6054
6060
|
}
|
@@ -7188,6 +7194,18 @@ declare namespace QuickSight {
|
|
7188
7194
|
* The ID of the folder.
|
7189
7195
|
*/
|
7190
7196
|
FolderId: RestrictiveResourceId;
|
7197
|
+
/**
|
7198
|
+
* The namespace of the folder whose permissions you want described.
|
7199
|
+
*/
|
7200
|
+
Namespace?: Namespace;
|
7201
|
+
/**
|
7202
|
+
* The maximum number of results to be returned per request.
|
7203
|
+
*/
|
7204
|
+
MaxResults?: MaxResults;
|
7205
|
+
/**
|
7206
|
+
* A pagination token for the next set of results.
|
7207
|
+
*/
|
7208
|
+
NextToken?: String;
|
7191
7209
|
}
|
7192
7210
|
export interface DescribeFolderPermissionsResponse {
|
7193
7211
|
/**
|
@@ -7210,6 +7228,10 @@ declare namespace QuickSight {
|
|
7210
7228
|
* The Amazon Web Services request ID for this operation.
|
7211
7229
|
*/
|
7212
7230
|
RequestId?: String;
|
7231
|
+
/**
|
7232
|
+
* The pagination token for the next set of results, or null if there are no more results.
|
7233
|
+
*/
|
7234
|
+
NextToken?: String;
|
7213
7235
|
}
|
7214
7236
|
export interface DescribeFolderRequest {
|
7215
7237
|
/**
|
@@ -7230,6 +7252,18 @@ declare namespace QuickSight {
|
|
7230
7252
|
* The ID of the folder.
|
7231
7253
|
*/
|
7232
7254
|
FolderId: RestrictiveResourceId;
|
7255
|
+
/**
|
7256
|
+
* The namespace of the folder whose permissions you want described.
|
7257
|
+
*/
|
7258
|
+
Namespace?: Namespace;
|
7259
|
+
/**
|
7260
|
+
* The maximum number of results to be returned per request.
|
7261
|
+
*/
|
7262
|
+
MaxResults?: MaxResults;
|
7263
|
+
/**
|
7264
|
+
* A pagination token for the next set of results.
|
7265
|
+
*/
|
7266
|
+
NextToken?: String;
|
7233
7267
|
}
|
7234
7268
|
export interface DescribeFolderResolvedPermissionsResponse {
|
7235
7269
|
/**
|
@@ -7252,6 +7286,10 @@ declare namespace QuickSight {
|
|
7252
7286
|
* The Amazon Web Services request ID for this operation.
|
7253
7287
|
*/
|
7254
7288
|
RequestId?: String;
|
7289
|
+
/**
|
7290
|
+
* A pagination token for the next set of results, or null if there are no more results.
|
7291
|
+
*/
|
7292
|
+
NextToken?: String;
|
7255
7293
|
}
|
7256
7294
|
export interface DescribeFolderResponse {
|
7257
7295
|
/**
|
@@ -8551,6 +8589,10 @@ declare namespace QuickSight {
|
|
8551
8589
|
* The configuration for applying a filter to specific sheets.
|
8552
8590
|
*/
|
8553
8591
|
SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
|
8592
|
+
/**
|
8593
|
+
* The configuration for applying a filter to all sheets.
|
8594
|
+
*/
|
8595
|
+
AllSheets?: AllSheetsFilterScopeConfiguration;
|
8554
8596
|
}
|
8555
8597
|
export interface FilterSelectableValues {
|
8556
8598
|
/**
|
@@ -8663,6 +8705,10 @@ declare namespace QuickSight {
|
|
8663
8705
|
* The time that the folder was last updated.
|
8664
8706
|
*/
|
8665
8707
|
LastUpdatedTime?: Timestamp;
|
8708
|
+
/**
|
8709
|
+
* The sharing scope of the folder.
|
8710
|
+
*/
|
8711
|
+
SharingModel?: SharingModel;
|
8666
8712
|
}
|
8667
8713
|
export type FolderColumnList = String[];
|
8668
8714
|
export type FolderFilterAttribute = "PARENT_FOLDER_ARN"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"FOLDER_NAME"|string;
|
@@ -8718,6 +8764,10 @@ declare namespace QuickSight {
|
|
8718
8764
|
* The time that the folder was last updated.
|
8719
8765
|
*/
|
8720
8766
|
LastUpdatedTime?: Timestamp;
|
8767
|
+
/**
|
8768
|
+
* The sharing scope of the folder.
|
8769
|
+
*/
|
8770
|
+
SharingModel?: SharingModel;
|
8721
8771
|
}
|
8722
8772
|
export type FolderSummaryList = FolderSummary[];
|
8723
8773
|
export type FolderType = "SHARED"|string;
|
@@ -8777,7 +8827,7 @@ declare namespace QuickSight {
|
|
8777
8827
|
/**
|
8778
8828
|
* The time field that is used in a computation.
|
8779
8829
|
*/
|
8780
|
-
Time
|
8830
|
+
Time?: DimensionField;
|
8781
8831
|
/**
|
8782
8832
|
* The value field that is used in a computation.
|
8783
8833
|
*/
|
@@ -9649,7 +9699,7 @@ declare namespace QuickSight {
|
|
9649
9699
|
/**
|
9650
9700
|
* The time field that is used in a computation.
|
9651
9701
|
*/
|
9652
|
-
Time
|
9702
|
+
Time?: DimensionField;
|
9653
9703
|
/**
|
9654
9704
|
* The value field that is used in a computation.
|
9655
9705
|
*/
|
@@ -11681,7 +11731,7 @@ declare namespace QuickSight {
|
|
11681
11731
|
/**
|
11682
11732
|
* The time field that is used in a computation.
|
11683
11733
|
*/
|
11684
|
-
Time
|
11734
|
+
Time?: DimensionField;
|
11685
11735
|
/**
|
11686
11736
|
* The value field that is used in a computation.
|
11687
11737
|
*/
|
@@ -11734,15 +11784,15 @@ declare namespace QuickSight {
|
|
11734
11784
|
/**
|
11735
11785
|
* The time field that is used in a computation.
|
11736
11786
|
*/
|
11737
|
-
Time
|
11787
|
+
Time?: DimensionField;
|
11738
11788
|
/**
|
11739
11789
|
* The field that is used in a metric comparison from value setup.
|
11740
11790
|
*/
|
11741
|
-
FromValue
|
11791
|
+
FromValue?: MeasureField;
|
11742
11792
|
/**
|
11743
11793
|
* The field that is used in a metric comparison to value setup.
|
11744
11794
|
*/
|
11745
|
-
TargetValue
|
11795
|
+
TargetValue?: MeasureField;
|
11746
11796
|
}
|
11747
11797
|
export interface MinimumLabelType {
|
11748
11798
|
/**
|
@@ -12522,7 +12572,7 @@ declare namespace QuickSight {
|
|
12522
12572
|
/**
|
12523
12573
|
* The time field that is used in a computation.
|
12524
12574
|
*/
|
12525
|
-
Time
|
12575
|
+
Time?: DimensionField;
|
12526
12576
|
/**
|
12527
12577
|
* The value field that is used in a computation.
|
12528
12578
|
*/
|
@@ -12540,7 +12590,7 @@ declare namespace QuickSight {
|
|
12540
12590
|
/**
|
12541
12591
|
* The time field that is used in a computation.
|
12542
12592
|
*/
|
12543
|
-
Time
|
12593
|
+
Time?: DimensionField;
|
12544
12594
|
/**
|
12545
12595
|
* The value field that is used in a computation.
|
12546
12596
|
*/
|
@@ -14507,6 +14557,7 @@ declare namespace QuickSight {
|
|
14507
14557
|
*/
|
14508
14558
|
BackgroundColor: ConditionalFormattingColor;
|
14509
14559
|
}
|
14560
|
+
export type SharingModel = "ACCOUNT"|"NAMESPACE"|string;
|
14510
14561
|
export interface Sheet {
|
14511
14562
|
/**
|
14512
14563
|
* The unique identifier associated with a sheet.
|
@@ -14781,15 +14832,15 @@ declare namespace QuickSight {
|
|
14781
14832
|
}
|
14782
14833
|
export interface SnapshotFile {
|
14783
14834
|
/**
|
14784
|
-
* A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations or 1 configuration for PDF.
|
14835
|
+
* A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
|
14785
14836
|
*/
|
14786
14837
|
SheetSelections: SnapshotFileSheetSelectionList;
|
14787
14838
|
/**
|
14788
|
-
* The format of the snapshot file to be generated. You can choose between CSV or PDF.
|
14839
|
+
* The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
|
14789
14840
|
*/
|
14790
14841
|
FormatType: SnapshotFileFormatType;
|
14791
14842
|
}
|
14792
|
-
export type SnapshotFileFormatType = "CSV"|"PDF"|string;
|
14843
|
+
export type SnapshotFileFormatType = "CSV"|"PDF"|"EXCEL"|string;
|
14793
14844
|
export interface SnapshotFileGroup {
|
14794
14845
|
/**
|
14795
14846
|
* A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
|
@@ -14800,15 +14851,15 @@ declare namespace QuickSight {
|
|
14800
14851
|
export type SnapshotFileList = SnapshotFile[];
|
14801
14852
|
export interface SnapshotFileSheetSelection {
|
14802
14853
|
/**
|
14803
|
-
* The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
|
14854
|
+
* The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
|
14804
14855
|
*/
|
14805
14856
|
SheetId: ShortRestrictiveResourceId;
|
14806
14857
|
/**
|
14807
|
-
* The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.
|
14858
|
+
* The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
|
14808
14859
|
*/
|
14809
14860
|
SelectionScope: SnapshotFileSheetSelectionScope;
|
14810
14861
|
/**
|
14811
|
-
* A
|
14862
|
+
* A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
|
14812
14863
|
*/
|
14813
14864
|
VisualIds?: SnapshotFileSheetSelectionVisualIdList;
|
14814
14865
|
}
|
@@ -15407,14 +15458,19 @@ declare namespace QuickSight {
|
|
15407
15458
|
export type TableFieldOptionList = TableFieldOption[];
|
15408
15459
|
export interface TableFieldOptions {
|
15409
15460
|
/**
|
15410
|
-
* The
|
15461
|
+
* The field options to be configured to a table.
|
15411
15462
|
*/
|
15412
15463
|
SelectedFieldOptions?: TableFieldOptionList;
|
15413
15464
|
/**
|
15414
|
-
* The order of field IDs
|
15465
|
+
* The order of the field IDs that are configured as field options for a table visual.
|
15415
15466
|
*/
|
15416
15467
|
Order?: FieldOrderList;
|
15468
|
+
/**
|
15469
|
+
* The settings for the pinned columns of a table visual.
|
15470
|
+
*/
|
15471
|
+
PinnedFieldOptions?: TablePinnedFieldOptions;
|
15417
15472
|
}
|
15473
|
+
export type TableFieldOrderList = FieldId[];
|
15418
15474
|
export interface TableFieldURLConfiguration {
|
15419
15475
|
/**
|
15420
15476
|
* The link configuration of a table field URL.
|
@@ -15471,6 +15527,12 @@ declare namespace QuickSight {
|
|
15471
15527
|
*/
|
15472
15528
|
OverflowColumnHeaderVisibility?: Visibility;
|
15473
15529
|
}
|
15530
|
+
export interface TablePinnedFieldOptions {
|
15531
|
+
/**
|
15532
|
+
* A list of columns to be pinned to the left of a table visual.
|
15533
|
+
*/
|
15534
|
+
PinnedLeftFields?: TableFieldOrderList;
|
15535
|
+
}
|
15474
15536
|
export interface TableRowConditionalFormatting {
|
15475
15537
|
/**
|
15476
15538
|
* The conditional formatting color (solid, gradient) of the background for a table row.
|
@@ -16234,11 +16296,11 @@ declare namespace QuickSight {
|
|
16234
16296
|
/**
|
16235
16297
|
* The time field that is used in a computation.
|
16236
16298
|
*/
|
16237
|
-
Time
|
16299
|
+
Time?: DimensionField;
|
16238
16300
|
/**
|
16239
16301
|
* The category field that is used in a computation.
|
16240
16302
|
*/
|
16241
|
-
Category
|
16303
|
+
Category?: DimensionField;
|
16242
16304
|
/**
|
16243
16305
|
* The value field that is used in a computation.
|
16244
16306
|
*/
|
@@ -16269,7 +16331,7 @@ declare namespace QuickSight {
|
|
16269
16331
|
/**
|
16270
16332
|
* The category field that is used in a computation.
|
16271
16333
|
*/
|
16272
|
-
Category
|
16334
|
+
Category?: DimensionField;
|
16273
16335
|
/**
|
16274
16336
|
* The value field that is used in a computation.
|
16275
16337
|
*/
|
@@ -16703,7 +16765,7 @@ declare namespace QuickSight {
|
|
16703
16765
|
/**
|
16704
16766
|
* The value field that is used in a computation.
|
16705
16767
|
*/
|
16706
|
-
Value
|
16768
|
+
Value?: MeasureField;
|
16707
16769
|
}
|
16708
16770
|
export interface TotalOptions {
|
16709
16771
|
/**
|
@@ -16973,7 +17035,7 @@ declare namespace QuickSight {
|
|
16973
17035
|
/**
|
16974
17036
|
* The category field that is used in a computation.
|
16975
17037
|
*/
|
16976
|
-
Category
|
17038
|
+
Category?: DimensionField;
|
16977
17039
|
}
|
16978
17040
|
export type UnlimitedPixelLength = string;
|
16979
17041
|
export interface UntagColumnOperation {
|
package/clients/rds.d.ts
CHANGED
@@ -8133,7 +8133,7 @@ declare namespace RDS {
|
|
8133
8133
|
*/
|
8134
8134
|
Engine: String;
|
8135
8135
|
/**
|
8136
|
-
* The version number of the database engine to use. To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Examples: 5.7.mysql_aurora.2.
|
8136
|
+
* The version number of the database engine to use. To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Examples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0
|
8137
8137
|
*/
|
8138
8138
|
EngineVersion?: String;
|
8139
8139
|
/**
|
@@ -8178,7 +8178,7 @@ declare namespace RDS {
|
|
8178
8178
|
*/
|
8179
8179
|
SourceEngine: String;
|
8180
8180
|
/**
|
8181
|
-
* The version of the database that the backup files were created from. MySQL versions 5.
|
8181
|
+
* The version of the database that the backup files were created from. MySQL versions 5.7 and 8.0 are supported. Example: 5.7.40, 8.0.28
|
8182
8182
|
*/
|
8183
8183
|
SourceEngineVersion: String;
|
8184
8184
|
/**
|
@@ -12,35 +12,35 @@ declare class VerifiedPermissions extends Service {
|
|
12
12
|
constructor(options?: VerifiedPermissions.Types.ClientConfiguration)
|
13
13
|
config: Config & VerifiedPermissions.Types.ClientConfiguration;
|
14
14
|
/**
|
15
|
-
* Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. To reference a user from this identity source in your Cedar policies, use the following syntax. IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId> Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool.
|
15
|
+
* Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. To reference a user from this identity source in your Cedar policies, use the following syntax. IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId> Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
16
16
|
*/
|
17
17
|
createIdentitySource(params: VerifiedPermissions.Types.CreateIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.CreateIdentitySourceOutput, AWSError>;
|
18
18
|
/**
|
19
|
-
* Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. To reference a user from this identity source in your Cedar policies, use the following syntax. IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId> Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool.
|
19
|
+
* Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. To reference a user from this identity source in your Cedar policies, use the following syntax. IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId> Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
20
20
|
*/
|
21
21
|
createIdentitySource(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.CreateIdentitySourceOutput, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template. Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.
|
23
|
+
* Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template. Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
24
24
|
*/
|
25
25
|
createPolicy(params: VerifiedPermissions.Types.CreatePolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyOutput, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template. Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.
|
27
|
+
* Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template. Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
28
28
|
*/
|
29
29
|
createPolicy(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyOutput, AWSError>;
|
30
30
|
/**
|
31
|
-
* Creates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store.
|
31
|
+
* Creates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
32
32
|
*/
|
33
33
|
createPolicyStore(params: VerifiedPermissions.Types.CreatePolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyStoreOutput, AWSError>;
|
34
34
|
/**
|
35
|
-
* Creates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store.
|
35
|
+
* Creates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
36
36
|
*/
|
37
37
|
createPolicyStore(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyStoreOutput, AWSError>;
|
38
38
|
/**
|
39
|
-
* Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
|
39
|
+
* Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
40
40
|
*/
|
41
41
|
createPolicyTemplate(params: VerifiedPermissions.Types.CreatePolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyTemplateOutput, AWSError>;
|
42
42
|
/**
|
43
|
-
* Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
|
43
|
+
* Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
44
44
|
*/
|
45
45
|
createPolicyTemplate(callback?: (err: AWSError, data: VerifiedPermissions.Types.CreatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.CreatePolicyTemplateOutput, AWSError>;
|
46
46
|
/**
|
@@ -164,43 +164,43 @@ declare class VerifiedPermissions extends Service {
|
|
164
164
|
*/
|
165
165
|
listPolicyTemplates(callback?: (err: AWSError, data: VerifiedPermissions.Types.ListPolicyTemplatesOutput) => void): Request<VerifiedPermissions.Types.ListPolicyTemplatesOutput, AWSError>;
|
166
166
|
/**
|
167
|
-
* Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
|
167
|
+
* Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
168
168
|
*/
|
169
169
|
putSchema(params: VerifiedPermissions.Types.PutSchemaInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.PutSchemaOutput) => void): Request<VerifiedPermissions.Types.PutSchemaOutput, AWSError>;
|
170
170
|
/**
|
171
|
-
* Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
|
171
|
+
* Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
172
172
|
*/
|
173
173
|
putSchema(callback?: (err: AWSError, data: VerifiedPermissions.Types.PutSchemaOutput) => void): Request<VerifiedPermissions.Types.PutSchemaOutput, AWSError>;
|
174
174
|
/**
|
175
|
-
* Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type.
|
175
|
+
* Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
176
176
|
*/
|
177
177
|
updateIdentitySource(params: VerifiedPermissions.Types.UpdateIdentitySourceInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.UpdateIdentitySourceOutput, AWSError>;
|
178
178
|
/**
|
179
|
-
* Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type.
|
179
|
+
* Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
180
180
|
*/
|
181
181
|
updateIdentitySource(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdateIdentitySourceOutput) => void): Request<VerifiedPermissions.Types.UpdateIdentitySourceOutput, AWSError>;
|
182
182
|
/**
|
183
|
-
* Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored. When you edit a static policy, You can change only certain elements of a static policy: The action referenced by the policy. A condition clause, such as when and unless. You can't change these elements of a static policy: Changing a policy from a static policy to a template-linked policy. Changing the effect of a static policy from permit or forbid. The principal referenced by a static policy. The resource referenced by a static policy. To update a template-linked policy, you must update the template instead.
|
183
|
+
* Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored. When you edit a static policy, You can change only certain elements of a static policy: The action referenced by the policy. A condition clause, such as when and unless. You can't change these elements of a static policy: Changing a policy from a static policy to a template-linked policy. Changing the effect of a static policy from permit or forbid. The principal referenced by a static policy. The resource referenced by a static policy. To update a template-linked policy, you must update the template instead. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
184
184
|
*/
|
185
185
|
updatePolicy(params: VerifiedPermissions.Types.UpdatePolicyInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyOutput, AWSError>;
|
186
186
|
/**
|
187
|
-
* Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored. When you edit a static policy, You can change only certain elements of a static policy: The action referenced by the policy. A condition clause, such as when and unless. You can't change these elements of a static policy: Changing a policy from a static policy to a template-linked policy. Changing the effect of a static policy from permit or forbid. The principal referenced by a static policy. The resource referenced by a static policy. To update a template-linked policy, you must update the template instead.
|
187
|
+
* Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored. When you edit a static policy, You can change only certain elements of a static policy: The action referenced by the policy. A condition clause, such as when and unless. You can't change these elements of a static policy: Changing a policy from a static policy to a template-linked policy. Changing the effect of a static policy from permit or forbid. The principal referenced by a static policy. The resource referenced by a static policy. To update a template-linked policy, you must update the template instead. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
188
188
|
*/
|
189
189
|
updatePolicy(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyOutput, AWSError>;
|
190
190
|
/**
|
191
|
-
* Modifies the validation setting for a policy store.
|
191
|
+
* Modifies the validation setting for a policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
192
192
|
*/
|
193
193
|
updatePolicyStore(params: VerifiedPermissions.Types.UpdatePolicyStoreInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyStoreOutput, AWSError>;
|
194
194
|
/**
|
195
|
-
* Modifies the validation setting for a policy store.
|
195
|
+
* Modifies the validation setting for a policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
196
196
|
*/
|
197
197
|
updatePolicyStore(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyStoreOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyStoreOutput, AWSError>;
|
198
198
|
/**
|
199
|
-
* Updates the specified policy template. You can update only the description and the some elements of the policyBody. Changes you make to the policy template content are immediately reflected in authorization decisions that involve all template-linked policies instantiated from this template.
|
199
|
+
* Updates the specified policy template. You can update only the description and the some elements of the policyBody. Changes you make to the policy template content are immediately reflected in authorization decisions that involve all template-linked policies instantiated from this template. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
200
200
|
*/
|
201
201
|
updatePolicyTemplate(params: VerifiedPermissions.Types.UpdatePolicyTemplateInput, callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyTemplateOutput, AWSError>;
|
202
202
|
/**
|
203
|
-
* Updates the specified policy template. You can update only the description and the some elements of the policyBody. Changes you make to the policy template content are immediately reflected in authorization decisions that involve all template-linked policies instantiated from this template.
|
203
|
+
* Updates the specified policy template. You can update only the description and the some elements of the policyBody. Changes you make to the policy template content are immediately reflected in authorization decisions that involve all template-linked policies instantiated from this template. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.
|
204
204
|
*/
|
205
205
|
updatePolicyTemplate(callback?: (err: AWSError, data: VerifiedPermissions.Types.UpdatePolicyTemplateOutput) => void): Request<VerifiedPermissions.Types.UpdatePolicyTemplateOutput, AWSError>;
|
206
206
|
}
|