package smaws-clients

  1. Overview
  2. Docs
Amazon Web Services SDK clients using EIO

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (1)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. C
    Chris Armstrong <oss@chrisarmstrong.dev>

Sources

0.1.preview1.tar.gz
md5=18fb70dbc45e8d81a341b9bed6871bab
sha512=7607dc98acaeed5803b44c9ca32d90c88e7813d4b3e3ae4ec661a0bad16c88dc1476bc780877527ea4cd5a4b7398453c1bb600ce0db14d39afa05dc4762b5ba5

doc/smaws-clients.pi/Smaws_Client_PI/index.html

Module Smaws_Client_PISource

Sourcetype untag_resource_response = unit
Sourcetype service_type =
  1. | DOCDB
  2. | RDS
Sourcetype untag_resource_request = {
  1. tag_keys : string list;
  2. resource_ar_n : string;
  3. service_type : service_type;
}
Sourcetype not_authorized_exception = {
  1. message : string option;
}
Sourcetype invalid_argument_exception = {
  1. message : string option;
}
Sourcetype internal_service_error = {
  1. message : string option;
}
Sourcetype text_format =
  1. | MARKDOWN
  2. | PLAIN_TEXT
Sourcetype tag_resource_response = unit
Sourcetype tag = {
  1. value : string;
  2. key : string;
}
Sourcetype tag_resource_request = {
  1. tags : tag list;
  2. resource_ar_n : string;
  3. service_type : service_type;
}
Sourcetype severity =
  1. | HIGH
  2. | MEDIUM
  3. | LOW
Sourcetype response_resource_metric = {
  1. unit_ : string option;
  2. description : string option;
  3. metric : string option;
}
Sourcetype response_resource_metric_key = {
  1. dimensions : (string * string) list option;
  2. metric : string;
}
Sourcetype response_partition_key = {
  1. dimensions : (string * string) list;
}
Sourcetype recommendation = {
  1. recommendation_description : string option;
  2. recommendation_id : string option;
}
Sourcetype period_alignment =
  1. | START_TIME
  2. | END_TIME
Sourcetype list_tags_for_resource_response = {
  1. tags : tag list option;
}
Sourcetype list_tags_for_resource_request = {
  1. resource_ar_n : string;
  2. service_type : service_type;
}
Sourcetype analysis_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | RUNNING
Sourcetype analysis_report_summary = {
  1. tags : tag list option;
  2. status : analysis_status option;
  3. end_time : float option;
  4. start_time : float option;
  5. create_time : float option;
  6. analysis_report_id : string option;
}
Sourcetype list_performance_analysis_reports_response = {
  1. next_token : string option;
  2. analysis_reports : analysis_report_summary list option;
}
Sourcetype list_performance_analysis_reports_request = {
  1. list_tags : bool option;
  2. max_results : int option;
  3. next_token : string option;
  4. identifier : string;
  5. service_type : service_type;
}
Sourcetype list_available_resource_metrics_response = {
  1. next_token : string option;
  2. metrics : response_resource_metric list option;
}
Sourcetype list_available_resource_metrics_request = {
  1. max_results : int option;
  2. next_token : string option;
  3. metric_types : string list;
  4. identifier : string;
  5. service_type : service_type;
}
Sourcetype dimension_detail = {
  1. identifier : string option;
}
Sourcetype dimension_group_detail = {
  1. dimensions : dimension_detail list option;
  2. group : string option;
}
Sourcetype metric_dimension_groups = {
  1. groups : dimension_group_detail list option;
  2. metric : string option;
}
Sourcetype list_available_resource_dimensions_response = {
  1. next_token : string option;
  2. metric_dimensions : metric_dimension_groups list option;
}
Sourcetype fine_grained_action =
  1. | GET_RESOURCE_METRICS
  2. | GET_DIMENSION_KEY_DETAILS
  3. | DESCRIBE_DIMENSION_KEYS
Sourcetype list_available_resource_dimensions_request = {
  1. authorized_actions : fine_grained_action list option;
  2. next_token : string option;
  3. max_results : int option;
  4. metrics : string list;
  5. identifier : string;
  6. service_type : service_type;
}
Sourcetype data_point = {
  1. value : float;
  2. timestamp_ : float;
}
Sourcetype metric_key_data_points = {
  1. data_points : data_point list option;
  2. key : response_resource_metric_key option;
}
Sourcetype get_resource_metrics_response = {
  1. next_token : string option;
  2. metric_list : metric_key_data_points list option;
  3. identifier : string option;
  4. aligned_end_time : float option;
  5. aligned_start_time : float option;
}
Sourcetype dimension_group = {
  1. limit : int option;
  2. dimensions : string list option;
  3. group : string;
}
Sourcetype metric_query = {
  1. filter : (string * string) list option;
  2. group_by : dimension_group option;
  3. metric : string;
}
Sourcetype get_resource_metrics_request = {
  1. period_alignment : period_alignment option;
  2. next_token : string option;
  3. max_results : int option;
  4. period_in_seconds : int option;
  5. end_time : float;
  6. start_time : float;
  7. metric_queries : metric_query list;
  8. identifier : string;
  9. service_type : service_type;
}
Sourcetype feature_status =
  1. | UNKNOWN
  2. | DISABLED_PENDING_REBOOT
  3. | ENABLED_PENDING_REBOOT
  4. | UNSUPPORTED
  5. | DISABLED
  6. | ENABLED
Sourcetype feature_metadata = {
  1. status : feature_status option;
}
Sourcetype get_resource_metadata_response = {
  1. features : (string * feature_metadata) list option;
  2. identifier : string option;
}
Sourcetype get_resource_metadata_request = {
  1. identifier : string;
  2. service_type : service_type;
}
Sourcetype context_type =
  1. | CONTEXTUAL
  2. | CAUSAL
Sourcetype performance_insights_metric = {
  1. value : float option;
  2. dimensions : (string * string) list option;
  3. display_name : string option;
  4. metric : string option;
}
Sourcetype data = {
  1. performance_insights_metric : performance_insights_metric option;
}
Sourcetype insight = {
  1. baseline_data : data list option;
  2. insight_data : data list option;
  3. recommendations : recommendation list option;
  4. description : string option;
  5. supporting_insights : insight list option;
  6. severity : severity option;
  7. end_time : float option;
  8. start_time : float option;
  9. context : context_type option;
  10. insight_type : string option;
  11. insight_id : string;
}
Sourcetype analysis_report = {
  1. insights : insight list option;
  2. status : analysis_status option;
  3. end_time : float option;
  4. start_time : float option;
  5. create_time : float option;
  6. service_type : service_type option;
  7. identifier : string option;
  8. analysis_report_id : string;
}
Sourcetype get_performance_analysis_report_response = {
  1. analysis_report : analysis_report option;
}
Sourcetype accept_language =
  1. | EN_US
Sourcetype get_performance_analysis_report_request = {
  1. accept_language : accept_language option;
  2. text_format : text_format option;
  3. analysis_report_id : string;
  4. identifier : string;
  5. service_type : service_type;
}
Sourcetype detail_status =
  1. | UNAVAILABLE
  2. | PROCESSING
  3. | AVAILABLE
Sourcetype dimension_key_detail = {
  1. status : detail_status option;
  2. dimension : string option;
  3. value : string option;
}
Sourcetype get_dimension_key_details_response = {
  1. dimensions : dimension_key_detail list option;
}
Sourcetype get_dimension_key_details_request = {
  1. requested_dimensions : string list option;
  2. group_identifier : string;
  3. group : string;
  4. identifier : string;
  5. service_type : service_type;
}
Sourcetype dimension_key_description = {
  1. partitions : float list option;
  2. additional_metrics : (string * float) list option;
  3. total : float option;
  4. dimensions : (string * string) list option;
}
Sourcetype describe_dimension_keys_response = {
  1. next_token : string option;
  2. keys : dimension_key_description list option;
  3. partition_keys : response_partition_key list option;
  4. aligned_end_time : float option;
  5. aligned_start_time : float option;
}
Sourcetype describe_dimension_keys_request = {
  1. next_token : string option;
  2. max_results : int option;
  3. filter : (string * string) list option;
  4. partition_by : dimension_group option;
  5. additional_metrics : string list option;
  6. group_by : dimension_group;
  7. period_in_seconds : int option;
  8. metric : string;
  9. end_time : float;
  10. start_time : float;
  11. identifier : string;
  12. service_type : service_type;
}
Sourcetype delete_performance_analysis_report_response = unit
Sourcetype delete_performance_analysis_report_request = {
  1. analysis_report_id : string;
  2. identifier : string;
  3. service_type : service_type;
}
Sourcetype create_performance_analysis_report_response = {
  1. analysis_report_id : string option;
}
Sourcetype create_performance_analysis_report_request = {
  1. tags : tag list option;
  2. end_time : float;
  3. start_time : float;
  4. identifier : string;
  5. service_type : service_type;
}
Sourcetype base_document = Smaws_Lib.Json.t
Sourceval make_untag_resource_response : unit -> untag_resource_response
Sourceval make_untag_resource_request : tag_keys:string list -> resource_ar_n:string -> service_type:service_type -> unit -> untag_resource_request
Sourceval make_tag_resource_response : unit -> tag_resource_response
Sourceval make_tag : value:string -> key:string -> unit -> tag
Sourceval make_tag_resource_request : tags:tag list -> resource_ar_n:string -> service_type:service_type -> unit -> tag_resource_request
Sourceval make_response_resource_metric : ?unit_:string -> ?description:string -> ?metric:string -> unit -> response_resource_metric
Sourceval make_response_resource_metric_key : ?dimensions:(string * string) list -> metric:string -> unit -> response_resource_metric_key
Sourceval make_response_partition_key : dimensions:(string * string) list -> unit -> response_partition_key
Sourceval make_recommendation : ?recommendation_description:string -> ?recommendation_id:string -> unit -> recommendation
Sourceval make_list_tags_for_resource_response : ?tags:tag list -> unit -> list_tags_for_resource_response
Sourceval make_list_tags_for_resource_request : resource_ar_n:string -> service_type:service_type -> unit -> list_tags_for_resource_request
Sourceval make_analysis_report_summary : ?tags:tag list -> ?status:analysis_status -> ?end_time:float -> ?start_time:float -> ?create_time:float -> ?analysis_report_id:string -> unit -> analysis_report_summary
Sourceval make_list_performance_analysis_reports_response : ?next_token:string -> ?analysis_reports:analysis_report_summary list -> unit -> list_performance_analysis_reports_response
Sourceval make_list_performance_analysis_reports_request : ?list_tags:bool -> ?max_results:int -> ?next_token:string -> identifier:string -> service_type:service_type -> unit -> list_performance_analysis_reports_request
Sourceval make_list_available_resource_metrics_response : ?next_token:string -> ?metrics:response_resource_metric list -> unit -> list_available_resource_metrics_response
Sourceval make_list_available_resource_metrics_request : ?max_results:int -> ?next_token:string -> metric_types:string list -> identifier:string -> service_type:service_type -> unit -> list_available_resource_metrics_request
Sourceval make_dimension_detail : ?identifier:string -> unit -> dimension_detail
Sourceval make_dimension_group_detail : ?dimensions:dimension_detail list -> ?group:string -> unit -> dimension_group_detail
Sourceval make_metric_dimension_groups : ?groups:dimension_group_detail list -> ?metric:string -> unit -> metric_dimension_groups
Sourceval make_list_available_resource_dimensions_response : ?next_token:string -> ?metric_dimensions:metric_dimension_groups list -> unit -> list_available_resource_dimensions_response
Sourceval make_list_available_resource_dimensions_request : ?authorized_actions:fine_grained_action list -> ?next_token:string -> ?max_results:int -> metrics:string list -> identifier:string -> service_type:service_type -> unit -> list_available_resource_dimensions_request
Sourceval make_data_point : value:float -> timestamp_:float -> unit -> data_point
Sourceval make_metric_key_data_points : ?data_points:data_point list -> ?key:response_resource_metric_key -> unit -> metric_key_data_points
Sourceval make_get_resource_metrics_response : ?next_token:string -> ?metric_list:metric_key_data_points list -> ?identifier:string -> ?aligned_end_time:float -> ?aligned_start_time:float -> unit -> get_resource_metrics_response
Sourceval make_dimension_group : ?limit:int -> ?dimensions:string list -> group:string -> unit -> dimension_group
Sourceval make_metric_query : ?filter:(string * string) list -> ?group_by:dimension_group -> metric:string -> unit -> metric_query
Sourceval make_get_resource_metrics_request : ?period_alignment:period_alignment -> ?next_token:string -> ?max_results:int -> ?period_in_seconds:int -> end_time:float -> start_time:float -> metric_queries:metric_query list -> identifier:string -> service_type:service_type -> unit -> get_resource_metrics_request
Sourceval make_feature_metadata : ?status:feature_status -> unit -> feature_metadata
Sourceval make_get_resource_metadata_response : ?features:(string * feature_metadata) list -> ?identifier:string -> unit -> get_resource_metadata_response
Sourceval make_get_resource_metadata_request : identifier:string -> service_type:service_type -> unit -> get_resource_metadata_request
Sourceval make_performance_insights_metric : ?value:float -> ?dimensions:(string * string) list -> ?display_name:string -> ?metric:string -> unit -> performance_insights_metric
Sourceval make_data : ?performance_insights_metric:performance_insights_metric -> unit -> data
Sourceval make_insight : ?baseline_data:data list -> ?insight_data:data list -> ?recommendations:recommendation list -> ?description:string -> ?supporting_insights:insight list -> ?severity:severity -> ?end_time:float -> ?start_time:float -> ?context:context_type -> ?insight_type:string -> insight_id:string -> unit -> insight
Sourceval make_analysis_report : ?insights:insight list -> ?status:analysis_status -> ?end_time:float -> ?start_time:float -> ?create_time:float -> ?service_type:service_type -> ?identifier:string -> analysis_report_id:string -> unit -> analysis_report
Sourceval make_get_performance_analysis_report_response : ?analysis_report:analysis_report -> unit -> get_performance_analysis_report_response
Sourceval make_get_performance_analysis_report_request : ?accept_language:accept_language -> ?text_format:text_format -> analysis_report_id:string -> identifier:string -> service_type:service_type -> unit -> get_performance_analysis_report_request
Sourceval make_dimension_key_detail : ?status:detail_status -> ?dimension:string -> ?value:string -> unit -> dimension_key_detail
Sourceval make_get_dimension_key_details_response : ?dimensions:dimension_key_detail list -> unit -> get_dimension_key_details_response
Sourceval make_get_dimension_key_details_request : ?requested_dimensions:string list -> group_identifier:string -> group:string -> identifier:string -> service_type:service_type -> unit -> get_dimension_key_details_request
Sourceval make_dimension_key_description : ?partitions:float list -> ?additional_metrics:(string * float) list -> ?total:float -> ?dimensions:(string * string) list -> unit -> dimension_key_description
Sourceval make_describe_dimension_keys_response : ?next_token:string -> ?keys:dimension_key_description list -> ?partition_keys:response_partition_key list -> ?aligned_end_time:float -> ?aligned_start_time:float -> unit -> describe_dimension_keys_response
Sourceval make_describe_dimension_keys_request : ?next_token:string -> ?max_results:int -> ?filter:(string * string) list -> ?partition_by:dimension_group -> ?additional_metrics:string list -> ?period_in_seconds:int -> group_by:dimension_group -> metric:string -> end_time:float -> start_time:float -> identifier:string -> service_type:service_type -> unit -> describe_dimension_keys_request
Sourceval make_delete_performance_analysis_report_response : unit -> delete_performance_analysis_report_response
Sourceval make_delete_performance_analysis_report_request : analysis_report_id:string -> identifier:string -> service_type:service_type -> unit -> delete_performance_analysis_report_request
Sourceval make_create_performance_analysis_report_response : ?analysis_report_id:string -> unit -> create_performance_analysis_report_response
Sourceval make_create_performance_analysis_report_request : ?tags:tag list -> end_time:float -> start_time:float -> identifier:string -> service_type:service_type -> unit -> create_performance_analysis_report_request
Sourcemodule UntagResource : sig ... end
Sourcemodule TagResource : sig ... end
Sourcemodule ListTagsForResource : sig ... end
Sourcemodule GetResourceMetrics : sig ... end
Sourcemodule GetResourceMetadata : sig ... end
Sourcemodule GetDimensionKeyDetails : sig ... end
Sourcemodule DescribeDimensionKeys : sig ... end