iam-floyd
Version:
AWS IAM policy statement generator with fluent interface
286 lines (285 loc) • 11.6 kB
TypeScript
import { AccessLevelList } from '../../shared/access-level';
import { PolicyStatement } from '../../shared';
/**
* Statement provider for service [machinelearning](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonmachinelearning.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class Machinelearning extends PolicyStatement {
servicePrefix: string;
/**
* Statement provider for service [machinelearning](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonmachinelearning.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
constructor(sid?: string);
/**
* Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value
*
* Access Level: Tagging
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_AddTags.html
*/
toAddTags(): this;
/**
* Generates predictions for a group of observations
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateBatchPrediction.html
*/
toCreateBatchPrediction(): this;
/**
* Creates a DataSource object from an Amazon RDS
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateDataSourceFromRDS.html
*/
toCreateDataSourceFromRDS(): this;
/**
* Creates a DataSource from a database hosted on an Amazon Redshift cluster
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateDataSourceFromRedshift.html
*/
toCreateDataSourceFromRedshift(): this;
/**
* Creates a DataSource object from S3
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateDataSourceFromS3.html
*/
toCreateDataSourceFromS3(): this;
/**
* Creates a new Evaluation of an MLModel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateEvaluation.html
*/
toCreateEvaluation(): this;
/**
* Creates a new MLModel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateMLModel.html
*/
toCreateMLModel(): this;
/**
* Creates a real-time endpoint for the MLModel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_CreateRealtimeEndpoint.html
*/
toCreateRealtimeEndpoint(): this;
/**
* Assigns the DELETED status to a BatchPrediction, rendering it unusable
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteBatchPrediction.html
*/
toDeleteBatchPrediction(): this;
/**
* Assigns the DELETED status to a DataSource, rendering it unusable
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteDataSource.html
*/
toDeleteDataSource(): this;
/**
* Assigns the DELETED status to an Evaluation, rendering it unusable
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteEvaluation.html
*/
toDeleteEvaluation(): this;
/**
* Assigns the DELETED status to an MLModel, rendering it unusable
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteMLModel.html
*/
toDeleteMLModel(): this;
/**
* Deletes a real time endpoint of an MLModel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteRealtimeEndpoint.html
*/
toDeleteRealtimeEndpoint(): this;
/**
* Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags
*
* Access Level: Tagging
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DeleteTags.html
*/
toDeleteTags(): this;
/**
* Returns a list of BatchPrediction operations that match the search criteria in the request
*
* Access Level: List
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeBatchPredictions.html
*/
toDescribeBatchPredictions(): this;
/**
* Returns a list of DataSource that match the search criteria in the request
*
* Access Level: List
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeDataSources.html
*/
toDescribeDataSources(): this;
/**
* Returns a list of DescribeEvaluations that match the search criteria in the request
*
* Access Level: List
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeEvaluations.html
*/
toDescribeEvaluations(): this;
/**
* Returns a list of MLModel that match the search criteria in the request
*
* Access Level: List
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeMLModels.html
*/
toDescribeMLModels(): this;
/**
* Describes one or more of the tags for your Amazon ML object
*
* Access Level: List
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_DescribeTags.html
*/
toDescribeTags(): this;
/**
* Returns a BatchPrediction that includes detailed metadata, status, and data file information
*
* Access Level: Read
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_GetBatchPrediction.html
*/
toGetBatchPrediction(): this;
/**
* Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_GetDataSource.html
*/
toGetDataSource(): this;
/**
* Returns an Evaluation that includes metadata as well as the current status of the Evaluation
*
* Access Level: Read
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_GetEvaluation.html
*/
toGetEvaluation(): this;
/**
* Returns an MLModel that includes detailed metadata, and data source information as well as the current status of the MLModel
*
* Access Level: Read
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_GetMLModel.html
*/
toGetMLModel(): this;
/**
* Generates a prediction for the observation using the specified ML Model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_Predict.html
*/
toPredict(): this;
/**
* Updates the BatchPredictionName of a BatchPrediction
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_UpdateBatchPrediction.html
*/
toUpdateBatchPrediction(): this;
/**
* Updates the DataSourceName of a DataSource
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_UpdateDataSource.html
*/
toUpdateDataSource(): this;
/**
* Updates the EvaluationName of an Evaluation
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_UpdateEvaluation.html
*/
toUpdateEvaluation(): this;
/**
* Updates the MLModelName and the ScoreThreshold of an MLModel
*
* Access Level: Write
*
* https://docs.aws.amazon.com/machine-learning/latest/APIReference/API_UpdateMLModel.html
*/
toUpdateMLModel(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type batchprediction to the statement
*
* https://docs.aws.amazon.com/machine-learning/latest/dg/amazon-machine-learning-key-concepts.html#batch-predictions
*
* @param batchPredictionId - Identifier for the batchPredictionId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*/
onBatchprediction(batchPredictionId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type datasource to the statement
*
* https://docs.aws.amazon.com/machine-learning/latest/dg/amazon-machine-learning-key-concepts.html#datasources
*
* @param datasourceId - Identifier for the datasourceId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*/
onDatasource(datasourceId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type evaluation to the statement
*
* https://docs.aws.amazon.com/machine-learning/latest/dg/amazon-machine-learning-key-concepts.html#evaluations
*
* @param evaluationId - Identifier for the evaluationId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*/
onEvaluation(evaluationId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type mlmodel to the statement
*
* https://docs.aws.amazon.com/machine-learning/latest/dg/amazon-machine-learning-key-concepts.html#ml-models
*
* @param mlModelId - Identifier for the mlModelId.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*/
onMlmodel(mlModelId: string, account?: string, region?: string, partition?: string): this;
}