ResourceGroupsTaggingAPI

public struct ResourceGroupsTaggingAPI

Client object for interacting with AWS ResourceGroupsTaggingAPI service.

Resource Groups Tagging API This guide describes the API operations for the resource groups tagging. A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of “Stack.” But the value of “Stack” might be “Testing” for one and “Production” for the other. 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. Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. You can use the resource groups tagging API operations to complete the following tasks: Tag and untag supported resources located in the specified Region for the AWS account. Use tag-based filters to search for resources located in the specified Region for the AWS account. List all existing tag keys in the specified Region for the AWS account. List all existing values for the specified key in the specified Region for the AWS account. To use resource groups tagging API operations, you must add the following permissions to your IAM policy: tag:GetResources tag:TagResources tag:UntagResources tag:GetTagKeys tag:GetTagValues You’ll also need permissions to access the resources of individual services so that you can tag and untag those resources. For more information on IAM policies, see Managing IAM Policies in the IAM User Guide. Services that support the Resource Groups Tagging API You can use the Resource Groups Tagging API to tag resources for the following AWS services. Alexa for Business (a4b) API Gateway Amazon AppStream AWS AppSync AWS App Mesh Amazon Athena Amazon Aurora AWS Backup AWS Certificate Manager AWS Certificate Manager Private CA Amazon Cloud Directory AWS Cloud Map AWS CloudFormation Amazon CloudFront AWS CloudHSM AWS CloudTrail Amazon CloudWatch (alarms only) Amazon CloudWatch Events Amazon CloudWatch Logs Amazon Cloudwatch Synthetics AWS CodeBuild AWS CodeCommit AWS CodePipeline AWS CodeStar AWS CodeStar Connections Amazon Cognito Identity Amazon Cognito User Pools Amazon Comprehend AWS Config Amazon Connect AWS Data Exchange AWS Data Pipeline AWS Database Migration Service AWS DataSync AWS Device Farm AWS Direct Connect AWS Directory Service Amazon DynamoDB Amazon EBS Amazon EC2 EC2 Image Builder Amazon ECR Amazon ECS Amazon EKS AWS Elastic Beanstalk Amazon Elastic File System Elastic Load Balancing Amazon ElastiCache Amazon Elasticsearch Service AWS Elemental MediaLive AWS Elemental MediaPackage AWS Elemental MediaPackage VoD AWS Elemental MediaTailor Amazon EMR Amazon EventBridge Schema AWS Firewall Manager Amazon FSx Amazon S3 Glacier AWS Global Accelerator AWS Ground Station AWS Glue Amazon GuardDuty Amazon Inspector AWS IoT Analytics AWS IoT Core AWS IoT Device Defender AWS IoT Device Management AWS IoT Events AWS IoT Greengrass AWS IoT 1-Click AWS IoT Sitewise AWS IoT Things Graph Amazon Kendra AWS Key Management Service Amazon Kinesis Amazon Kinesis Data Analytics Amazon Kinesis Data Firehose AWS Lambda Amazon Lex AWS License Manager Amazon Macie Amazon Machine Learning Amazon MQ Amazon MSK Amazon Neptune AWS OpsWorks AWS OpsWorks CM AWS Organizations Amazon Pinpoint Amazon Quantum Ledger Database (QLDB) Amazon RDS Amazon Redshift AWS Resource Access Manager AWS Resource Groups AWS RoboMaker Amazon Route 53 Amazon Route 53 Resolver Amazon S3 (buckets only) Amazon SageMaker Savings Plans AWS Secrets Manager AWS Security Hub AWS Service Catalog Amazon Simple Email Service (SES) Amazon Simple Notification Service (SNS) Amazon Simple Queue Service (SQS) Amazon Simple Workflow Service AWS Step Functions AWS Storage Gateway AWS Systems Manager AWS Transfer for SFTP Amazon VPC AWS WAFv2 AWS WAF Regional Amazon WorkLink Amazon WorkSpaces

Member variables

Initialization

  • Initialize the ResourceGroupsTaggingAPI client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Describes the status of the StartReportCreation operation. You can call this operation only from the organization’s master account and from the us-east-1 Region.

    Declaration

    Swift

    public func describeReportCreation(_ input: DescribeReportCreationInput) -> EventLoopFuture<DescribeReportCreationOutput>

  • Returns 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 AWS Organizations User Guide. You can call this operation only from the organization’s master account and from the us-east-1 Region.

    Declaration

    Swift

    public func getComplianceSummary(_ input: GetComplianceSummaryInput) -> EventLoopFuture<GetComplianceSummaryOutput>

  • Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS 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 AWS Organizations User Guide. You can check the PaginationToken response parameter to determine if a query is complete. Queries occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

    Declaration

    Swift

    public func getResources(_ input: GetResourcesInput) -> EventLoopFuture<GetResourcesOutput>

  • Returns all tag keys in the specified Region for the AWS account.

    Declaration

    Swift

    public func getTagKeys(_ input: GetTagKeysInput) -> EventLoopFuture<GetTagKeysOutput>

  • Returns all tag values for the specified key in the specified Region for the AWS account.

    Declaration

    Swift

    public func getTagValues(_ input: GetTagValuesInput) -> EventLoopFuture<GetTagValuesOutput>

  • Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The generated report is saved to the following location: s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv You can call this operation only from the organization’s master account and from the us-east-1 Region.

    Declaration

    Swift

    public func startReportCreation(_ input: StartReportCreationInput) -> EventLoopFuture<StartReportCreationOutput>

  • Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of services that support tagging, see this list. Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference. You can only tag resources that are located in the specified Region for the AWS 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 this list. 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.

    Declaration

    Swift

    public func tagResources(_ input: TagResourcesInput) -> EventLoopFuture<TagResourcesOutput>

  • 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 this list. You can only tag resources that are located in the specified Region for the AWS account.

    Declaration

    Swift

    public func untagResources(_ input: UntagResourcesInput) -> EventLoopFuture<UntagResourcesOutput>

Paginators

  • Returns 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 AWS Organizations User Guide. You can call this operation only from the organization’s master account and from the us-east-1 Region.

    Declaration

    Swift

    public func getComplianceSummaryPaginator(_ input: GetComplianceSummaryInput, onPage: @escaping (GetComplianceSummaryOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS 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 AWS Organizations User Guide. You can check the PaginationToken response parameter to determine if a query is complete. Queries occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

    Declaration

    Swift

    public func getResourcesPaginator(_ input: GetResourcesInput, onPage: @escaping (GetResourcesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns all tag keys in the specified Region for the AWS account.

    Declaration

    Swift

    public func getTagKeysPaginator(_ input: GetTagKeysInput, onPage: @escaping (GetTagKeysOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns all tag values for the specified key in the specified Region for the AWS account.

    Declaration

    Swift

    public func getTagValuesPaginator(_ input: GetTagValuesInput, onPage: @escaping (GetTagValuesOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ErrorCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum GroupByAttribute : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TargetIdType : String, CustomStringConvertible, Codable