Module Smaws_Client_ResourceGroupsTaggingAPI

Resource Groups Tagging API client library built on EIO.

Types

type error_code =
  1. | INVALID_PARAMETER_EXCEPTION
  2. | INTERNAL_SERVICE_EXCEPTION
type failure_info = {
  1. error_message : string option;
    (*

    The message of the common error.

    *)
  2. error_code : error_code option;
    (*

    The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.

    *)
  3. status_code : int option;
    (*

    The HTTP status code of the common error.

    *)
}

Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.

The following are common error codes that you might receive from other Amazon Web Services services:

  • InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it's safe to retry the request and then call GetResources to verify the changes.
  • AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both TagResources and TagResource in the CloudWatch API.

For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.

type untag_resources_output = {
  1. failed_resources_map : (string * failure_info) list option;
    (*

    A map containing a key-value pair for each failed item that couldn't be untagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

    *)
}
type untag_resources_input = {
  1. tag_keys : string list;
    (*

    Specifies a list of tag keys that you want to remove from the specified resources.

    *)
  2. resource_arn_list : string list;
    (*

    Specifies a list of ARNs of the resources that you want to remove tags from.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    *)
}
type throttled_exception = {
  1. message : string option;
}

The request was denied to limit the frequency of submitted requests.

type invalid_parameter_exception = {
  1. message : string option;
}

This error indicates one of the following:

  • A parameter is missing.
  • A malformed string was supplied for the request parameter.
  • An out-of-range value was supplied for the request parameter.
  • The target ID is invalid, unsupported, or doesn't exist.
  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the Organizations User Guide.
type internal_service_exception = {
  1. message : string option;
}

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

type target_id_type =
  1. | ROOT
  2. | OU
  3. | ACCOUNT
type tag_resources_output = {
  1. failed_resources_map : (string * failure_info) list option;
    (*

    A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

    *)
}
type tag_resources_input = {
  1. tags : (string * string) list;
    (*

    Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

    *)
  2. resource_arn_list : string list;
    (*

    Specifies the list of ARNs of the resources that you want to apply tags to.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    *)
}
type tag = {
  1. value : string;
    (*

    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

    *)
  2. key : string;
    (*

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    *)
}

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

type tag_filter = {
  1. values : string list option;
    (*

    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

    *)
  2. key : string option;
    (*

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    *)
}

A list of tags (keys and values) that are used to specify the associated resources.

type summary = {
  1. non_compliant_resources : int option;
    (*

    The count of noncompliant resources.

    *)
  2. resource_type : string option;
    (*

    The Amazon Web Services resource type.

    *)
  3. region : string option;
    (*

    The Amazon Web Services Region that the summary applies to.

    *)
  4. target_id_type : target_id_type option;
    (*

    Whether the target is an account, an OU, or the organization root.

    *)
  5. target_id : string option;
    (*

    The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API.

    *)
  6. last_updated : string option;
    (*

    The timestamp that shows when this summary was generated in this Region.

    *)
}

A count of noncompliant resources.

type start_report_creation_output = unit
type start_report_creation_input = {
  1. s3_bucket : string;
    (*

    The name of the Amazon S3 bucket where the report will be stored; for example:

    awsexamplebucket

    For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.

    *)
}
type constraint_violation_exception = {
  1. message : string option;
}

The request was denied because performing this operation violates a constraint.

Some of the reasons in the following list might not apply to this specific operation.

  • You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the Organizations User Guide.
  • You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with Organizations For information, see EnableAWSServiceAccess.
  • You must have a tag policy attached to the organization root, an OU, or an account.
type concurrent_modification_exception = {
  1. message : string option;
}

The target of the operation is currently being modified by a different request. Try again later.

type compliance_details = {
  1. compliance_status : bool option;
    (*

    Whether a resource is compliant with the effective tag policy.

    *)
  2. keys_with_noncompliant_values : string list option;
    (*

    These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values.

    *)
  3. noncompliant_keys : string list option;
    (*

    These tag keys on the resource are noncompliant with the effective tag policy.

    *)
}

Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.

type resource_tag_mapping = {
  1. compliance_details : compliance_details option;
    (*

    Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.

    *)
  2. tags : tag list option;
    (*

    The tags that have been applied to one or more Amazon Web Services resources.

    *)
  3. resource_ar_n : string option;
    (*

    The ARN of the resource.

    *)
}

A list of resource ARNs and the tags (keys and values) that are associated with each.

type pagination_token_expired_exception = {
  1. message : string option;
}

A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

type get_tag_values_output = {
  1. tag_values : string list option;
    (*

    A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.

    *)
  2. pagination_token : string option;
    (*

    A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    *)
}
type get_tag_values_input = {
  1. key : string;
    (*

    Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

    *)
  2. pagination_token : string option;
    (*

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

    *)
}
type get_tag_keys_output = {
  1. tag_keys : string list option;
    (*

    A list of all tag keys in the Amazon Web Services account.

    *)
  2. pagination_token : string option;
    (*

    A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    *)
}
type get_tag_keys_input = {
  1. pagination_token : string option;
    (*

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

    *)
}
type get_resources_output = {
  1. resource_tag_mapping_list : resource_tag_mapping list option;
    (*

    A list of resource ARNs and the tags (keys and values) associated with each.

    *)
  2. pagination_token : string option;
    (*

    A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    *)
}
type get_resources_input = {
  1. resource_arn_list : string list option;
    (*

    Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

    If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

    An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    *)
  2. exclude_compliant_resources : bool option;
    (*

    Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

    You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

    *)
  3. include_compliance_details : bool option;
    (*

    Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

    *)
  4. resource_type_filters : string list option;
    (*

    Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

    ec2:instance,s3:bucket,auditmanager

    *)
  5. tags_per_page : int option;
    (*

    Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

    A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

    GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

    You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.

    *)
  6. resources_per_page : int option;
    (*

    Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

    *)
  7. tag_filters : tag_filter list option;
    (*

    Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

    Note the following when deciding how to use TagFilters:

    • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].
    • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
    • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

    • If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.

      For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

      • GetResources({filter1}) returns resources tagged with key1=value1
      • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
      • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value
      • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
    *)
  8. pagination_token : string option;
    (*

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

    *)
}
type get_compliance_summary_output = {
  1. pagination_token : string option;
    (*

    A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    *)
  2. summary_list : summary list option;
    (*

    A table that shows counts of noncompliant resources.

    *)
}
type group_by_attribute =
  1. | RESOURCE_TYPE
  2. | REGION
  3. | TARGET_ID
type get_compliance_summary_input = {
  1. pagination_token : string option;
    (*

    Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

    *)
  2. max_results : int option;
    (*

    Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

    *)
  3. group_by : group_by_attribute list option;
    (*

    Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

    *)
  4. tag_key_filters : string list option;
    (*

    Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

    *)
  5. resource_type_filters : string list option;
    (*

    Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

    You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

    *)
  6. region_filters : string list option;
    (*

    Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

    *)
  7. target_id_filters : string list option;
    (*

    Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

    *)
}
type describe_report_creation_output = {
  1. error_message : string option;
    (*

    Details of the common errors that all operations return.

    *)
  2. start_date : string option;
    (*

    The date and time that the report was started.

    *)
  3. s3_location : string option;
    (*

    The path to the Amazon S3 bucket where the report was stored on creation.

    *)
  4. status : string option;
    (*

    Reports the status of the operation.

    The operation status can be one of the following:

    • RUNNING - Report creation is in progress.
    • SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you specified when you ran StartReportCreation.
    • FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.
    • NO REPORT - No report was generated in the last 90 days.
    *)
}
type describe_report_creation_input = unit

Resource Groups Tagging API

type base_document = Smaws_Lib.Json.t

Builders

val make_failure_info : ?error_message:string -> ?error_code:error_code -> ?status_code:int -> unit -> failure_info

Create a failure_info type

val make_untag_resources_output : ?failed_resources_map:(string * failure_info) list -> unit -> untag_resources_output

Create a untag_resources_output type

val make_untag_resources_input : tag_keys:string list -> resource_arn_list:string list -> unit -> untag_resources_input

Create a untag_resources_input type

val make_tag_resources_output : ?failed_resources_map:(string * failure_info) list -> unit -> tag_resources_output

Create a tag_resources_output type

val make_tag_resources_input : tags:(string * string) list -> resource_arn_list:string list -> unit -> tag_resources_input

Create a tag_resources_input type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_tag_filter : ?values:string list -> ?key:string -> unit -> tag_filter

Create a tag_filter type

val make_summary : ?non_compliant_resources:int -> ?resource_type:string -> ?region:string -> ?target_id_type:target_id_type -> ?target_id:string -> ?last_updated:string -> unit -> summary

Create a summary type

val make_start_report_creation_output : unit -> start_report_creation_output

Create a start_report_creation_output type

val make_start_report_creation_input : s3_bucket:string -> unit -> start_report_creation_input

Create a start_report_creation_input type

val make_compliance_details : ?compliance_status:bool -> ?keys_with_noncompliant_values:string list -> ?noncompliant_keys:string list -> unit -> compliance_details

Create a compliance_details type

val make_resource_tag_mapping : ?compliance_details:compliance_details -> ?tags:tag list -> ?resource_ar_n:string -> unit -> resource_tag_mapping

Create a resource_tag_mapping type

val make_get_tag_values_output : ?tag_values:string list -> ?pagination_token:string -> unit -> get_tag_values_output

Create a get_tag_values_output type

val make_get_tag_values_input : ?pagination_token:string -> key:string -> unit -> get_tag_values_input

Create a get_tag_values_input type

val make_get_tag_keys_output : ?tag_keys:string list -> ?pagination_token:string -> unit -> get_tag_keys_output

Create a get_tag_keys_output type

val make_get_tag_keys_input : ?pagination_token:string -> unit -> get_tag_keys_input

Create a get_tag_keys_input type

val make_get_resources_output : ?resource_tag_mapping_list:resource_tag_mapping list -> ?pagination_token:string -> unit -> get_resources_output

Create a get_resources_output type

val make_get_resources_input : ?resource_arn_list:string list -> ?exclude_compliant_resources:bool -> ?include_compliance_details:bool -> ?resource_type_filters:string list -> ?tags_per_page:int -> ?resources_per_page:int -> ?tag_filters:tag_filter list -> ?pagination_token:string -> unit -> get_resources_input

Create a get_resources_input type

val make_get_compliance_summary_output : ?pagination_token:string -> ?summary_list:summary list -> unit -> get_compliance_summary_output

Create a get_compliance_summary_output type

val make_get_compliance_summary_input : ?pagination_token:string -> ?max_results:int -> ?group_by:group_by_attribute list -> ?tag_key_filters:string list -> ?resource_type_filters:string list -> ?region_filters:string list -> ?target_id_filters:string list -> unit -> get_compliance_summary_input

Create a get_compliance_summary_input type

val make_describe_report_creation_output : ?error_message:string -> ?start_date:string -> ?s3_location:string -> ?status:string -> unit -> describe_report_creation_output

Create a describe_report_creation_output type

val make_describe_report_creation_input : unit -> describe_report_creation_input

Create a describe_report_creation_input type

Operations

module DescribeReportCreation : sig ... end
module GetComplianceSummary : sig ... end
module GetResources : sig ... end
module GetTagKeys : sig ... end
module GetTagValues : sig ... end
module StartReportCreation : sig ... end
module TagResources : sig ... end
module UntagResources : sig ... end