package awso-async
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=47224890900b1f5d2bd717000a02fa8918f92eafa99f702f7d59a1b053ff8e95
sha512=e187288f7c8fccb221f5417671732c8c8de95cdbacba1514db592b5700df2293468bde07956539bd44f3d460f6c75d38bd66ca161d0eae68a8b1b4e081882367
doc/awso-async.resourcegroupstaggingapi/Awso_resourcegroupstaggingapi_async/index.html
Module Awso_resourcegroupstaggingapi_asyncSource
val describe_report_creation :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.DescribeReportCreationInput.t ->
(Awso_resourcegroupstaggingapi.Values.DescribeReportCreationOutput.t,
Awso_resourcegroupstaggingapi.Values.DescribeReportCreationOutput.error)
Result.t
Async.Deferred.tval get_compliance_summary :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.GetComplianceSummaryInput.t ->
(Awso_resourcegroupstaggingapi.Values.GetComplianceSummaryOutput.t,
Awso_resourcegroupstaggingapi.Values.GetComplianceSummaryOutput.error)
Result.t
Async.Deferred.tval get_resources :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.GetResourcesInput.t ->
(Awso_resourcegroupstaggingapi.Values.GetResourcesOutput.t,
Awso_resourcegroupstaggingapi.Values.GetResourcesOutput.error)
Result.t
Async.Deferred.tval get_tag_keys :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.GetTagKeysInput.t ->
(Awso_resourcegroupstaggingapi.Values.GetTagKeysOutput.t,
Awso_resourcegroupstaggingapi.Values.GetTagKeysOutput.error)
Result.t
Async.Deferred.tval get_tag_values :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.GetTagValuesInput.t ->
(Awso_resourcegroupstaggingapi.Values.GetTagValuesOutput.t,
Awso_resourcegroupstaggingapi.Values.GetTagValuesOutput.error)
Result.t
Async.Deferred.tval list_required_tags :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.ListRequiredTagsInput.t ->
(Awso_resourcegroupstaggingapi.Values.ListRequiredTagsOutput.t,
Awso_resourcegroupstaggingapi.Values.ListRequiredTagsOutput.error)
Result.t
Async.Deferred.tval start_report_creation :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.StartReportCreationInput.t ->
(Awso_resourcegroupstaggingapi.Values.StartReportCreationOutput.t,
Awso_resourcegroupstaggingapi.Values.StartReportCreationOutput.error)
Result.t
Async.Deferred.tval tag_resources :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.TagResourcesInput.t ->
(Awso_resourcegroupstaggingapi.Values.TagResourcesOutput.t,
Awso_resourcegroupstaggingapi.Values.TagResourcesOutput.error)
Result.t
Async.Deferred.tval untag_resources :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_resourcegroupstaggingapi.Values.UntagResourcesInput.t ->
(Awso_resourcegroupstaggingapi.Values.UntagResourcesOutput.t,
Awso_resourcegroupstaggingapi.Values.UntagResourcesOutput.error)
Result.t
Async.Deferred.tinclude module type of struct include Awso_resourcegroupstaggingapi.Values end
val structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]module CloudFormationResourceType =
Awso_resourcegroupstaggingapi.Values.CloudFormationResourceTypeThe 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.
module CloudFormationResourceTypes =
Awso_resourcegroupstaggingapi.Values.CloudFormationResourceTypesInformation that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
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.
Information that describes the required tags for a given resource type.
A list of resource ARNs and the tags (keys and values) that are associated with each.
A list of tags (keys and values) that are used to specify the associated resources.
A count of noncompliant resources.
module InternalServiceException =
Awso_resourcegroupstaggingapi.Values.InternalServiceExceptionThe request processing failed because of an unknown error, exception, or failure. You can retry the request.
module InvalidParameterException =
Awso_resourcegroupstaggingapi.Values.InvalidParameterExceptionThe request failed because of one of the following reasons: A required parameter is missing. A provided string parameter is malformed. An provided parameter value is out of range. 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 Amazon S3 bucket policy for report storage in the Tagging Amazon Web Services resources and Tag Editor user guide. The partition specified in an ARN parameter in the request doesn't match the partition where you invoked the operation. The partition is specified by the second field of the ARN.
The request failed because it exceeded the allowed frequency of submitted requests.
module ResourceARNListForTagUntag =
Awso_resourcegroupstaggingapi.Values.ResourceARNListForTagUntagmodule ConcurrentModificationException =
Awso_resourcegroupstaggingapi.Values.ConcurrentModificationExceptionThe request failed because the target of the operation is currently being modified by a different request. Try again later.
module ConstraintViolationException =
Awso_resourcegroupstaggingapi.Values.ConstraintViolationExceptionThe request failed because performing the operation would violate 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 in the Tagging Amazon Web Services resources and Tag Editor 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.
module PaginationTokenExpiredException =
Awso_resourcegroupstaggingapi.Values.PaginationTokenExpiredExceptionThe request failed because the specified PaginationToken has expired. A PaginationToken is valid for a maximum of 15 minutes.
module RequiredTagsForListRequiredTags =
Awso_resourcegroupstaggingapi.Values.RequiredTagsForListRequiredTagsmodule MaxResultsForListRequiredTags =
Awso_resourcegroupstaggingapi.Values.MaxResultsForListRequiredTagsmodule ExcludeCompliantResources =
Awso_resourcegroupstaggingapi.Values.ExcludeCompliantResourcesmodule IncludeComplianceDetails =
Awso_resourcegroupstaggingapi.Values.IncludeComplianceDetailsmodule MaxResultsGetComplianceSummary =
Awso_resourcegroupstaggingapi.Values.MaxResultsGetComplianceSummaryRemoves the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account. Minimum permissions In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions: tag:UntagResources ec2:DeleteTags In addition, some services might have specific requirements for untagging some types of resources. For example, to untag Amazon Web Services Glue Connection, you must also have the glue:GetConnection permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account. Minimum permissions In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions: tag:UntagResources ec2:DeleteTags In addition, some services might have specific requirements for untagging some types of resources. For example, to untag Amazon Web Services Glue Connection, you must also have the glue:GetConnection permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service. Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference. You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service. When you use the Amazon Web Services Resource Groups Tagging API to update tags for Amazon Web Services CloudFormation stack sets, Amazon Web Services calls the Amazon Web Services CloudFormation UpdateStack operation. This operation may initiate additional resource property updates in addition to the desired tag updates. To avoid unexpected resource updates, Amazon Web Services recommends that you only apply or update tags to your CloudFormation stack sets using Amazon Web Services CloudFormation. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions: tag:TagResources ec2:CreateTags In addition, some services might have specific requirements for tagging some types of resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service. Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference. You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account. To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service. When you use the Amazon Web Services Resource Groups Tagging API to update tags for Amazon Web Services CloudFormation stack sets, Amazon Web Services calls the Amazon Web Services CloudFormation UpdateStack operation. This operation may initiate additional resource property updates in addition to the desired tag updates. To avoid unexpected resource updates, Amazon Web Services recommends that you only apply or update tags to your CloudFormation stack sets using Amazon Web Services CloudFormation. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions: tag:TagResources ec2:CreateTags In addition, some services might have specific requirements for tagging some types of resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.
module StartReportCreationOutput =
Awso_resourcegroupstaggingapi.Values.StartReportCreationOutputGenerates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously. The generated report is saved to the following location: s3://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv For more information about evaluating resource compliance with tag policies, including the required permissions, review Permissions for evaluating organization-wide compliance in the Tagging Amazon Web Services Resources and Tag Editor user guide. You can call this operation only from the organization's management account and from the us-east-1 Region. If the account associated with the identity used to call StartReportCreation is different from the account that owns the Amazon S3 bucket, there must be a bucket policy attached to the bucket to provide access. For more information, review Amazon S3 bucket policy for report storage in the Tagging Amazon Web Services Resources and Tag Editor user guide.
module StartReportCreationInput =
Awso_resourcegroupstaggingapi.Values.StartReportCreationInputGenerates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously. The generated report is saved to the following location: s3://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv For more information about evaluating resource compliance with tag policies, including the required permissions, review Permissions for evaluating organization-wide compliance in the Tagging Amazon Web Services Resources and Tag Editor user guide. You can call this operation only from the organization's management account and from the us-east-1 Region. If the account associated with the identity used to call StartReportCreation is different from the account that owns the Amazon S3 bucket, there must be a bucket policy attached to the bucket to provide access. For more information, review Amazon S3 bucket policy for report storage in the Tagging Amazon Web Services Resources and Tag Editor user guide.
Lists the required tags for supported resource types in an Amazon Web Services account.
Lists the required tags for supported resource types in an Amazon Web Services account.
Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account. Depending on what information you want returned, you can also specify the following: Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources. Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. GetResources does not return untagged resources. To find untagged resources in your account, use Amazon Web Services Resource Explorer with a query that uses tag:none. For more information, see Search query syntax reference for Resource Explorer.
Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account. Depending on what information you want returned, you can also specify the following: Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources. Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned. GetResources does not return untagged resources. To find untagged resources in your account, use Amazon Web Services Resource Explorer with a query that uses tag:none. For more information, see Search query syntax reference for Resource Explorer.
module GetComplianceSummaryOutput =
Awso_resourcegroupstaggingapi.Values.GetComplianceSummaryOutputReturns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies in the Organizations User Guide. You can call this operation only from the organization's management account and from the us-east-1 Region. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
module GetComplianceSummaryInput =
Awso_resourcegroupstaggingapi.Values.GetComplianceSummaryInputReturns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies in the Organizations User Guide. You can call this operation only from the organization's management account and from the us-east-1 Region. This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.
module DescribeReportCreationOutput =
Awso_resourcegroupstaggingapi.Values.DescribeReportCreationOutputDescribes the status of the StartReportCreation operation. You can call this operation only from the organization's management account and from the us-east-1 Region.
module DescribeReportCreationInput =
Awso_resourcegroupstaggingapi.Values.DescribeReportCreationInputDescribes the status of the StartReportCreation operation. You can call this operation only from the organization's management account and from the us-east-1 Region.