Documentation

Overview

    Package resourcegroupstaggingapi provides the API client, operations, and parameter types for AWS Resource Groups Tagging API.

    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 (http://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html) 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) (https://docs.aws.amazon.com/a4b)

    * API Gateway (https://docs.aws.amazon.com/apigateway)

    * Amazon AppStream (https://docs.aws.amazon.com/appstream2)

    * AWS AppSync (https://docs.aws.amazon.com/appsync)

    * AWS App Mesh (https://docs.aws.amazon.com/app-mesh)

    * Amazon Athena (https://docs.aws.amazon.com/athena)

    * Amazon Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide)

    * AWS Backup (https://docs.aws.amazon.com/aws-backup)

    * AWS Certificate Manager (https://docs.aws.amazon.com/acm)

    * AWS Certificate Manager Private CA (https://docs.aws.amazon.com/acm)

    * Amazon Cloud Directory (https://docs.aws.amazon.com/clouddirectory)

    * AWS Cloud Map (https://docs.aws.amazon.com/cloud-map)

    * AWS CloudFormation (https://docs.aws.amazon.com/cloudformation)

    * Amazon CloudFront (https://docs.aws.amazon.com/cloudfront)

    * AWS CloudHSM (https://docs.aws.amazon.com/cloudhsm)

    * AWS CloudTrail (https://docs.aws.amazon.com/cloudtrail)

    * Amazon CloudWatch (alarms only) (https://docs.aws.amazon.com/cloudwatch)

    * Amazon CloudWatch Events (https://docs.aws.amazon.com/cloudwatch/?id=docs_gateway#amazon-cloudwatch-events)

    * Amazon CloudWatch Logs (https://docs.aws.amazon.com/cloudwatch/?id=docs_gateway#amazon-cloudwatch-logs)

    * Amazon Cloudwatch Synthetics (https://docs.aws.amazon.com/cloudwatch)

    * AWS CodeBuild (https://docs.aws.amazon.com/codebuild)

    * AWS CodeCommit (https://docs.aws.amazon.com/codecommit)

    * AWS CodeGuru Profiler (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/)

    * AWS CodePipeline (https://docs.aws.amazon.com/codepipeline)

    * AWS CodeStar (https://docs.aws.amazon.com/codestar)

    * AWS CodeStar Connections (https://docs.aws.amazon.com/codestar-connections/latest/APIReference/)

    * Amazon Cognito Identity (https://docs.aws.amazon.com/cognito)

    * Amazon Cognito User Pools (https://docs.aws.amazon.com/cognito)

    * Amazon Comprehend (https://docs.aws.amazon.com/comprehend)

    * AWS Config (https://docs.aws.amazon.com/config)

    * Amazon Connect (http://aws.amazon.com/connect/resources/?whats-new-cards#Documentation)

    * AWS Data Exchange (https://docs.aws.amazon.com/data-exchange)

    * AWS Data Pipeline (https://docs.aws.amazon.com/data-pipeline)

    * AWS Database Migration Service (https://docs.aws.amazon.com/dms)

    * AWS DataSync (https://docs.aws.amazon.com/datasync)

    * AWS Device Farm (https://docs.aws.amazon.com/devicefarm)

    * AWS Direct Connect (https://docs.aws.amazon.com/directconnect)

    * AWS Directory Service (https://docs.aws.amazon.com/directory-service)

    * Amazon DynamoDB (https://docs.aws.amazon.com/dynamodb)

    * Amazon EBS (https://docs.aws.amazon.com/ebs)

    * Amazon EC2 (https://docs.aws.amazon.com/ec2)

    * EC2 Image Builder (https://docs.aws.amazon.com/imagebuilder)

    * Amazon ECR (https://docs.aws.amazon.com/ecr)

    * Amazon ECS (https://docs.aws.amazon.com/ecs)

    * Amazon EKS (https://docs.aws.amazon.com/eks)

    * AWS Elastic Beanstalk (https://docs.aws.amazon.com/elastic-beanstalk)

    * Amazon Elastic File System (https://docs.aws.amazon.com/efs)

    * Elastic Load Balancing (https://docs.aws.amazon.com/elasticloadbalancing)

    * Amazon Elastic Inference (https://docs.aws.amazon.com/elastic-inference)

    * Amazon ElastiCache (https://docs.aws.amazon.com/elasticache)

    * Amazon Elasticsearch Service (https://docs.aws.amazon.com/elasticsearch-service)

    * AWS Elemental MediaLive (https://docs.aws.amazon.com/medialive)

    * AWS Elemental MediaPackage (https://docs.aws.amazon.com/mediapackage)

    * AWS Elemental MediaPackage VoD (https://docs.aws.amazon.com/mediapackage)

    * AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor)

    * Amazon EMR (https://docs.aws.amazon.com/emr)

    * Amazon EventBridge Schema (https://docs.aws.amazon.com/eventbridge)

    * AWS Firewall Manager (https://docs.aws.amazon.com/firewall-manager)

    * Amazon Forecast (https://docs.aws.amazon.com/forecast)

    * Amazon Fraud Detector (https://docs.aws.amazon.com/frauddetector)

    * Amazon FSx (https://docs.aws.amazon.com/fsx)

    * Amazon S3 Glacier (https://docs.aws.amazon.com/s3/?id=docs_gateway#amazon-s3-glacier)

    * AWS Global Accelerator (https://docs.aws.amazon.com/global-accelerator)

    * AWS Ground Station (https://docs.aws.amazon.com/ground-station)

    * AWS Glue (https://docs.aws.amazon.com/glue)

    * Amazon GuardDuty (https://docs.aws.amazon.com/guardduty)

    * Amazon Inspector (https://docs.aws.amazon.com/inspector)

    * Amazon Interactive Video Service (https://docs.aws.amazon.com/ivs)

    * AWS IoT Analytics (https://docs.aws.amazon.com/iotanalytics)

    * AWS IoT Core (https://docs.aws.amazon.com/iot)

    * AWS IoT Device Defender (https://docs.aws.amazon.com/iot-device-defender)

    * AWS IoT Device Management (https://docs.aws.amazon.com/iot-device-management)

    * AWS IoT Events (https://docs.aws.amazon.com/iotevents)

    * AWS IoT Greengrass (https://docs.aws.amazon.com/greengrass)

    * AWS IoT 1-Click (https://docs.aws.amazon.com/iot-1-click)

    * AWS IoT Sitewise (https://docs.aws.amazon.com/iot-sitewise)

    * AWS IoT Things Graph (https://docs.aws.amazon.com/thingsgraph)

    * Amazon Kendra (https://docs.aws.amazon.com/kendra)

    * AWS Key Management Service (https://docs.aws.amazon.com/kms)

    * Amazon Kinesis (https://docs.aws.amazon.com/kinesis)

    * Amazon Kinesis Data Analytics (https://docs.aws.amazon.com/kinesis/?id=docs_gateway#amazon-kinesis-data-analytics)

    * Amazon Kinesis Data Firehose (https://docs.aws.amazon.com/kinesis/?id=docs_gateway#amazon-kinesis-data-firehose)

    * AWS Lambda (https://docs.aws.amazon.com/lambda)

    * Amazon Lex (https://docs.aws.amazon.com/lex)

    * AWS License Manager (https://docs.aws.amazon.com/license-manager)

    * Amazon Lightsail (https://docs.aws.amazon.com/lightsail)

    * Amazon Macie (https://docs.aws.amazon.com/macie)

    * Amazon Machine Learning (https://docs.aws.amazon.com/machine-learning)

    * Amazon MQ (https://docs.aws.amazon.com/amazon-mq)

    * Amazon MSK (https://docs.aws.amazon.com/msk)

    * Amazon MSK (https://docs.aws.amazon.com/msk)

    * Amazon Neptune (https://docs.aws.amazon.com/neptune)

    * AWS Network Manager (https://docs.aws.amazon.com/vpc/latest/tgw/what-is-network-manager.html)

    * AWS OpsWorks (https://docs.aws.amazon.com/opsworks)

    * AWS OpsWorks CM (https://docs.aws.amazon.com/opsworks)

    * AWS Organizations (https://docs.aws.amazon.com/organizations)

    * Amazon Pinpoint (https://docs.aws.amazon.com/pinpoint)

    * Amazon Quantum Ledger Database (QLDB) (https://docs.aws.amazon.com/qldb)

    * Amazon RDS (https://docs.aws.amazon.com/rds)

    * Amazon Redshift (https://docs.aws.amazon.com/redshift)

    * AWS Resource Access Manager (https://docs.aws.amazon.com/ram)

    * AWS Resource Groups (https://docs.aws.amazon.com/ARG)

    * AWS RoboMaker (https://docs.aws.amazon.com/robomaker)

    * Amazon Route 53 (https://docs.aws.amazon.com/route53)

    * Amazon Route 53 Resolver (https://docs.aws.amazon.com/route53)

    * Amazon S3 (buckets only) (https://docs.aws.amazon.com/s3)

    * Amazon SageMaker (https://docs.aws.amazon.com/sagemaker)

    * Savings Plans (https://docs.aws.amazon.com/savingsplans)

    * AWS Secrets Manager (https://docs.aws.amazon.com/secretsmanager)

    * AWS Security Hub (https://docs.aws.amazon.com/securityhub)

    * AWS Service Catalog (https://docs.aws.amazon.com/servicecatalog)

    * Amazon Simple Email Service (SES) (https://docs.aws.amazon.com/ses)

    * Amazon Simple Notification Service (SNS) (https://docs.aws.amazon.com/sns)

    * Amazon Simple Queue Service (SQS) (https://docs.aws.amazon.com/sqs)

    * Amazon Simple Workflow Service (https://docs.aws.amazon.com/swf)

    * AWS Step Functions (https://docs.aws.amazon.com/step-functions)

    * AWS Storage Gateway (https://docs.aws.amazon.com/storagegateway)

    * AWS Systems Manager (https://docs.aws.amazon.com/systems-manager)

    * AWS Transfer for SFTP (https://docs.aws.amazon.com/transfer)

    * Amazon VPC (https://docs.aws.amazon.com/vpc)

    * AWS WAF (https://docs.aws.amazon.com/waf)

    * AWS WAF Regional (https://docs.aws.amazon.com/waf)

    * Amazon WorkLink (https://docs.aws.amazon.com/worklink)

    * Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces)

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-01-26"
    View Source
    const ServiceID = "Resource Groups Tagging API"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Resource Groups Tagging API.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DescribeReportCreation

                func (c *Client) DescribeReportCreation(ctx context.Context, params *DescribeReportCreationInput, optFns ...func(*Options)) (*DescribeReportCreationOutput, error)

                  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.

                  func (*Client) GetComplianceSummary

                  func (c *Client) GetComplianceSummary(ctx context.Context, params *GetComplianceSummaryInput, optFns ...func(*Options)) (*GetComplianceSummaryOutput, error)

                    Returns a table that shows counts of resources that are noncompliant with their tag policies. For more information on tag policies, see Tag Policies (http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) 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.

                    func (*Client) GetResources

                    func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, optFns ...func(*Options)) (*GetResourcesOutput, error)

                      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 (http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) 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.

                      func (*Client) GetTagKeys

                      func (c *Client) GetTagKeys(ctx context.Context, params *GetTagKeysInput, optFns ...func(*Options)) (*GetTagKeysOutput, error)

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

                        func (*Client) GetTagValues

                        func (c *Client) GetTagValues(ctx context.Context, params *GetTagValuesInput, optFns ...func(*Options)) (*GetTagValuesOutput, error)

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

                          func (*Client) StartReportCreation

                          func (c *Client) StartReportCreation(ctx context.Context, params *StartReportCreationInput, optFns ...func(*Options)) (*StartReportCreationOutput, error)

                            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.

                            func (*Client) TagResources

                            func (c *Client) TagResources(ctx context.Context, params *TagResourcesInput, optFns ...func(*Options)) (*TagResourcesOutput, error)

                              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 (http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html).

                              * Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions (http://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-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 (http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html).

                              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.

                              func (*Client) UntagResources

                              func (c *Client) UntagResources(ctx context.Context, params *UntagResourcesInput, optFns ...func(*Options)) (*UntagResourcesOutput, error)

                                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 (http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html).

                                * You can only tag resources that are located in the specified Region for the AWS account.

                                type DescribeReportCreationInput

                                type DescribeReportCreationInput struct {
                                }

                                type DescribeReportCreationOutput

                                type DescribeReportCreationOutput struct {
                                
                                	// Details of the common errors that all operations return.
                                	ErrorMessage *string
                                
                                	// The path to the Amazon S3 bucket where the report was stored on creation.
                                	S3Location *string
                                
                                	// The date and time that the report was started.
                                	StartDate *string
                                
                                	// 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.
                                	Status *string
                                
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type EndpointResolver

                                type EndpointResolver interface {
                                	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                }

                                  EndpointResolver interface for resolving service endpoints.

                                  func EndpointResolverFromURL

                                  func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                    EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                    type EndpointResolverFunc

                                    type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                      EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                      func (EndpointResolverFunc) ResolveEndpoint

                                      func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                      type EndpointResolverOptions

                                      type EndpointResolverOptions = internalendpoints.Options

                                        EndpointResolverOptions is the service endpoint resolver options

                                        type GetComplianceSummaryAPIClient

                                        type GetComplianceSummaryAPIClient interface {
                                        	GetComplianceSummary(context.Context, *GetComplianceSummaryInput, ...func(*Options)) (*GetComplianceSummaryOutput, error)
                                        }

                                          GetComplianceSummaryAPIClient is a client that implements the GetComplianceSummary operation.

                                          type GetComplianceSummaryInput

                                          type GetComplianceSummaryInput struct {
                                          
                                          	// A list of attributes to group the counts of noncompliant resources by. If
                                          	// supplied, the counts are sorted by those attributes.
                                          	GroupBy []types.GroupByAttribute
                                          
                                          	// A limit that restricts the number of results that are returned per page.
                                          	MaxResults *int32
                                          
                                          	// A string that indicates that additional data is available. Leave this value
                                          	// empty for your initial request. If the response includes a PaginationToken, use
                                          	// that string for this value to request an additional page of data.
                                          	PaginationToken *string
                                          
                                          	// A list of Regions to limit the output by. If you use this parameter, the count
                                          	// of returned noncompliant resources includes only resources in the specified
                                          	// Regions.
                                          	RegionFilters []string
                                          
                                          	// The constraints on the resources that you want returned. 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 AWS General Reference for the
                                          	// following:
                                          	//
                                          	// * For a list of service name strings, see AWS Service Namespaces
                                          	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
                                          	//
                                          	// *
                                          	// For resource type strings, see Example ARNs
                                          	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
                                          	//
                                          	// *
                                          	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
                                          	// Service Namespaces
                                          	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
                                          	//
                                          	// 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.
                                          	ResourceTypeFilters []string
                                          
                                          	// A list of tag keys to limit the output by. If you use this parameter, the count
                                          	// of returned noncompliant resources includes only resources that have the
                                          	// specified tag keys.
                                          	TagKeyFilters []string
                                          
                                          	// The 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.
                                          	TargetIdFilters []string
                                          }

                                          type GetComplianceSummaryOutput

                                          type GetComplianceSummaryOutput struct {
                                          
                                          	// A string that indicates that the response contains more data than can be
                                          	// returned in a single response. To receive additional data, specify this string
                                          	// for the PaginationToken value in a subsequent request.
                                          	PaginationToken *string
                                          
                                          	// A table that shows counts of noncompliant resources.
                                          	SummaryList []types.Summary
                                          
                                          	// Metadata pertaining to the operation's result.
                                          	ResultMetadata middleware.Metadata
                                          }

                                          type GetComplianceSummaryPaginator

                                          type GetComplianceSummaryPaginator struct {
                                          	// contains filtered or unexported fields
                                          }

                                            GetComplianceSummaryPaginator is a paginator for GetComplianceSummary

                                            func NewGetComplianceSummaryPaginator

                                              NewGetComplianceSummaryPaginator returns a new GetComplianceSummaryPaginator

                                              func (*GetComplianceSummaryPaginator) HasMorePages

                                              func (p *GetComplianceSummaryPaginator) HasMorePages() bool

                                                HasMorePages returns a boolean indicating whether more pages are available

                                                func (*GetComplianceSummaryPaginator) NextPage

                                                  NextPage retrieves the next GetComplianceSummary page.

                                                  type GetComplianceSummaryPaginatorOptions

                                                  type GetComplianceSummaryPaginatorOptions struct {
                                                  	// A limit that restricts the number of results that are returned per page.
                                                  	Limit int32
                                                  
                                                  	// Set to true if pagination should stop if the service returns a pagination token
                                                  	// that matches the most recent token provided to the service.
                                                  	StopOnDuplicateToken bool
                                                  }

                                                    GetComplianceSummaryPaginatorOptions is the paginator options for GetComplianceSummary

                                                    type GetResourcesAPIClient

                                                    type GetResourcesAPIClient interface {
                                                    	GetResources(context.Context, *GetResourcesInput, ...func(*Options)) (*GetResourcesOutput, error)
                                                    }

                                                      GetResourcesAPIClient is a client that implements the GetResources operation.

                                                      type GetResourcesInput

                                                      type GetResourcesInput struct {
                                                      
                                                      	// 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.
                                                      	ExcludeCompliantResources *bool
                                                      
                                                      	// 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.
                                                      	IncludeComplianceDetails *bool
                                                      
                                                      	// A string that indicates that additional data is available. Leave this value
                                                      	// empty for your initial request. If the response includes a PaginationToken, use
                                                      	// that string for this value to request an additional page of data.
                                                      	PaginationToken *string
                                                      
                                                      	// The constraints on the resources that you want returned. 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 AWS General Reference for the
                                                      	// following:
                                                      	//
                                                      	// * For a list of service name strings, see AWS Service Namespaces
                                                      	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).
                                                      	//
                                                      	// *
                                                      	// For resource type strings, see Example ARNs
                                                      	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).
                                                      	//
                                                      	// *
                                                      	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
                                                      	// Service Namespaces
                                                      	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
                                                      	//
                                                      	// 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.
                                                      	ResourceTypeFilters []string
                                                      
                                                      	// A limit that restricts the number of resources returned by GetResources in
                                                      	// paginated output. You can set ResourcesPerPage to a minimum of 1 item and the
                                                      	// maximum of 100 items.
                                                      	ResourcesPerPage *int32
                                                      
                                                      	// A list of TagFilters (keys and values). Each TagFilter specified must contain a
                                                      	// key with values as 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 do specify a TagFilter, the response returns only those
                                                      	// resources that are currently associated with the specified tag.
                                                      	//
                                                      	// * If you don't
                                                      	// specify a TagFilter, the response includes all resources that were ever
                                                      	// associated with tags. Resources that currently don't have associated 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 specified 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 any values for a key, the
                                                      	// response returns resources that are tagged with that key irrespective of the
                                                      	// value. For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2,
                                                      	// {value2,value3,value4}} , filter3 = {key3}:
                                                      	//
                                                      	// * 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 containing key3 as its tag key,
                                                      	// irrespective of its value
                                                      	//
                                                      	// * GetResources( {filter1,filter2,filter3} ) returns
                                                      	// resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or
                                                      	// key2=value4) and (key3, irrespective of the value)
                                                      	TagFilters []types.TagFilter
                                                      
                                                      	// AWS 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 and the maximum of 500 items.
                                                      	TagsPerPage *int32
                                                      }

                                                      type GetResourcesOutput

                                                      type GetResourcesOutput struct {
                                                      
                                                      	// A string that indicates that the response contains more data than can be
                                                      	// returned in a single response. To receive additional data, specify this string
                                                      	// for the PaginationToken value in a subsequent request.
                                                      	PaginationToken *string
                                                      
                                                      	// A list of resource ARNs and the tags (keys and values) associated with each.
                                                      	ResourceTagMappingList []types.ResourceTagMapping
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type GetResourcesPaginator

                                                      type GetResourcesPaginator struct {
                                                      	// contains filtered or unexported fields
                                                      }

                                                        GetResourcesPaginator is a paginator for GetResources

                                                        func NewGetResourcesPaginator

                                                        func NewGetResourcesPaginator(client GetResourcesAPIClient, params *GetResourcesInput, optFns ...func(*GetResourcesPaginatorOptions)) *GetResourcesPaginator

                                                          NewGetResourcesPaginator returns a new GetResourcesPaginator

                                                          func (*GetResourcesPaginator) HasMorePages

                                                          func (p *GetResourcesPaginator) HasMorePages() bool

                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                            func (*GetResourcesPaginator) NextPage

                                                            func (p *GetResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcesOutput, error)

                                                              NextPage retrieves the next GetResources page.

                                                              type GetResourcesPaginatorOptions

                                                              type GetResourcesPaginatorOptions struct {
                                                              	// A limit that restricts the number of resources returned by GetResources in
                                                              	// paginated output. You can set ResourcesPerPage to a minimum of 1 item and the
                                                              	// maximum of 100 items.
                                                              	Limit int32
                                                              
                                                              	// Set to true if pagination should stop if the service returns a pagination token
                                                              	// that matches the most recent token provided to the service.
                                                              	StopOnDuplicateToken bool
                                                              }

                                                                GetResourcesPaginatorOptions is the paginator options for GetResources

                                                                type GetTagKeysAPIClient

                                                                type GetTagKeysAPIClient interface {
                                                                	GetTagKeys(context.Context, *GetTagKeysInput, ...func(*Options)) (*GetTagKeysOutput, error)
                                                                }

                                                                  GetTagKeysAPIClient is a client that implements the GetTagKeys operation.

                                                                  type GetTagKeysInput

                                                                  type GetTagKeysInput struct {
                                                                  	MaxResults *int32
                                                                  
                                                                  	// A string that indicates that additional data is available. Leave this value
                                                                  	// empty for your initial request. If the response includes a PaginationToken, use
                                                                  	// that string for this value to request an additional page of data.
                                                                  	PaginationToken *string
                                                                  }

                                                                  type GetTagKeysOutput

                                                                  type GetTagKeysOutput struct {
                                                                  
                                                                  	// A string that indicates that the response contains more data than can be
                                                                  	// returned in a single response. To receive additional data, specify this string
                                                                  	// for the PaginationToken value in a subsequent request.
                                                                  	PaginationToken *string
                                                                  
                                                                  	// A list of all tag keys in the AWS account.
                                                                  	TagKeys []string
                                                                  
                                                                  	// Metadata pertaining to the operation's result.
                                                                  	ResultMetadata middleware.Metadata
                                                                  }

                                                                  type GetTagKeysPaginator

                                                                  type GetTagKeysPaginator struct {
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                    GetTagKeysPaginator is a paginator for GetTagKeys

                                                                    func NewGetTagKeysPaginator

                                                                    func NewGetTagKeysPaginator(client GetTagKeysAPIClient, params *GetTagKeysInput, optFns ...func(*GetTagKeysPaginatorOptions)) *GetTagKeysPaginator

                                                                      NewGetTagKeysPaginator returns a new GetTagKeysPaginator

                                                                      func (*GetTagKeysPaginator) HasMorePages

                                                                      func (p *GetTagKeysPaginator) HasMorePages() bool

                                                                        HasMorePages returns a boolean indicating whether more pages are available

                                                                        func (*GetTagKeysPaginator) NextPage

                                                                        func (p *GetTagKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTagKeysOutput, error)

                                                                          NextPage retrieves the next GetTagKeys page.

                                                                          type GetTagKeysPaginatorOptions

                                                                          type GetTagKeysPaginatorOptions struct {
                                                                          	// Set to true if pagination should stop if the service returns a pagination token
                                                                          	// that matches the most recent token provided to the service.
                                                                          	StopOnDuplicateToken bool
                                                                          }

                                                                            GetTagKeysPaginatorOptions is the paginator options for GetTagKeys

                                                                            type GetTagValuesAPIClient

                                                                            type GetTagValuesAPIClient interface {
                                                                            	GetTagValues(context.Context, *GetTagValuesInput, ...func(*Options)) (*GetTagValuesOutput, error)
                                                                            }

                                                                              GetTagValuesAPIClient is a client that implements the GetTagValues operation.

                                                                              type GetTagValuesInput

                                                                              type GetTagValuesInput struct {
                                                                              
                                                                              	// The key for which you want to list all existing values in the specified Region
                                                                              	// for the AWS account.
                                                                              	//
                                                                              	// This member is required.
                                                                              	Key *string
                                                                              
                                                                              	MaxResults *int32
                                                                              
                                                                              	// A string that indicates that additional data is available. Leave this value
                                                                              	// empty for your initial request. If the response includes a PaginationToken, use
                                                                              	// that string for this value to request an additional page of data.
                                                                              	PaginationToken *string
                                                                              }

                                                                              type GetTagValuesOutput

                                                                              type GetTagValuesOutput struct {
                                                                              
                                                                              	// A string that indicates that the response contains more data than can be
                                                                              	// returned in a single response. To receive additional data, specify this string
                                                                              	// for the PaginationToken value in a subsequent request.
                                                                              	PaginationToken *string
                                                                              
                                                                              	// A list of all tag values for the specified key in the AWS account.
                                                                              	TagValues []string
                                                                              
                                                                              	// Metadata pertaining to the operation's result.
                                                                              	ResultMetadata middleware.Metadata
                                                                              }

                                                                              type GetTagValuesPaginator

                                                                              type GetTagValuesPaginator struct {
                                                                              	// contains filtered or unexported fields
                                                                              }

                                                                                GetTagValuesPaginator is a paginator for GetTagValues

                                                                                func NewGetTagValuesPaginator

                                                                                func NewGetTagValuesPaginator(client GetTagValuesAPIClient, params *GetTagValuesInput, optFns ...func(*GetTagValuesPaginatorOptions)) *GetTagValuesPaginator

                                                                                  NewGetTagValuesPaginator returns a new GetTagValuesPaginator

                                                                                  func (*GetTagValuesPaginator) HasMorePages

                                                                                  func (p *GetTagValuesPaginator) HasMorePages() bool

                                                                                    HasMorePages returns a boolean indicating whether more pages are available

                                                                                    func (*GetTagValuesPaginator) NextPage

                                                                                    func (p *GetTagValuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTagValuesOutput, error)

                                                                                      NextPage retrieves the next GetTagValues page.

                                                                                      type GetTagValuesPaginatorOptions

                                                                                      type GetTagValuesPaginatorOptions struct {
                                                                                      	// Set to true if pagination should stop if the service returns a pagination token
                                                                                      	// that matches the most recent token provided to the service.
                                                                                      	StopOnDuplicateToken bool
                                                                                      }

                                                                                        GetTagValuesPaginatorOptions is the paginator options for GetTagValues

                                                                                        type HTTPClient

                                                                                        type HTTPClient interface {
                                                                                        	Do(*http.Request) (*http.Response, error)
                                                                                        }

                                                                                        type HTTPSignerV4

                                                                                        type HTTPSignerV4 interface {
                                                                                        	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                                        }

                                                                                        type Options

                                                                                        type Options struct {
                                                                                        	// Set of options to modify how an operation is invoked. These apply to all
                                                                                        	// operations invoked for this client. Use functional options on operation call to
                                                                                        	// modify this list for per operation behavior.
                                                                                        	APIOptions []func(*middleware.Stack) error
                                                                                        
                                                                                        	// Configures the events that will be sent to the configured logger.
                                                                                        	ClientLogMode aws.ClientLogMode
                                                                                        
                                                                                        	// The credentials object to use when signing requests.
                                                                                        	Credentials aws.CredentialsProvider
                                                                                        
                                                                                        	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                        	EndpointOptions EndpointResolverOptions
                                                                                        
                                                                                        	// The service endpoint resolver.
                                                                                        	EndpointResolver EndpointResolver
                                                                                        
                                                                                        	// Signature Version 4 (SigV4) Signer
                                                                                        	HTTPSignerV4 HTTPSignerV4
                                                                                        
                                                                                        	// The logger writer interface to write logging messages to.
                                                                                        	Logger logging.Logger
                                                                                        
                                                                                        	// The region to send requests to. (Required)
                                                                                        	Region string
                                                                                        
                                                                                        	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                        	// failures. When nil the API client will use a default retryer.
                                                                                        	Retryer aws.Retryer
                                                                                        
                                                                                        	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                        	// implementation if nil.
                                                                                        	HTTPClient HTTPClient
                                                                                        }

                                                                                        func (Options) Copy

                                                                                        func (o Options) Copy() Options

                                                                                          Copy creates a clone where the APIOptions list is deep copied.

                                                                                          type ResolveEndpoint

                                                                                          type ResolveEndpoint struct {
                                                                                          	Resolver EndpointResolver
                                                                                          	Options  EndpointResolverOptions
                                                                                          }

                                                                                          func (*ResolveEndpoint) HandleSerialize

                                                                                          func (*ResolveEndpoint) ID

                                                                                          func (*ResolveEndpoint) ID() string

                                                                                          type StartReportCreationInput

                                                                                          type StartReportCreationInput struct {
                                                                                          
                                                                                          	// 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.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	S3Bucket *string
                                                                                          }

                                                                                          type StartReportCreationOutput

                                                                                          type StartReportCreationOutput struct {
                                                                                          	// Metadata pertaining to the operation's result.
                                                                                          	ResultMetadata middleware.Metadata
                                                                                          }

                                                                                          type TagResourcesInput

                                                                                          type TagResourcesInput struct {
                                                                                          
                                                                                          	// A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource.
                                                                                          	// For more information, see Amazon Resource Names (ARNs) and AWS Service
                                                                                          	// Namespaces
                                                                                          	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in
                                                                                          	// the AWS General Reference.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	ResourceARNList []string
                                                                                          
                                                                                          	// The tags that you want to add to the specified resources. A tag consists of a
                                                                                          	// key and a value that you define.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	Tags map[string]string
                                                                                          }

                                                                                          type TagResourcesOutput

                                                                                          type TagResourcesOutput struct {
                                                                                          
                                                                                          	// 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.
                                                                                          	FailedResourcesMap map[string]types.FailureInfo
                                                                                          
                                                                                          	// Metadata pertaining to the operation's result.
                                                                                          	ResultMetadata middleware.Metadata
                                                                                          }

                                                                                          type UntagResourcesInput

                                                                                          type UntagResourcesInput struct {
                                                                                          
                                                                                          	// A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource.
                                                                                          	// For more information, see Amazon Resource Names (ARNs) and AWS Service
                                                                                          	// Namespaces
                                                                                          	// (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in
                                                                                          	// the AWS General Reference.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	ResourceARNList []string
                                                                                          
                                                                                          	// A list of the tag keys that you want to remove from the specified resources.
                                                                                          	//
                                                                                          	// This member is required.
                                                                                          	TagKeys []string
                                                                                          }

                                                                                          type UntagResourcesOutput

                                                                                          type UntagResourcesOutput struct {
                                                                                          
                                                                                          	// Details of resources that could not be untagged. An error code, status code, and
                                                                                          	// error message are returned for each failed item.
                                                                                          	FailedResourcesMap map[string]types.FailureInfo
                                                                                          
                                                                                          	// Metadata pertaining to the operation's result.
                                                                                          	ResultMetadata middleware.Metadata
                                                                                          }

                                                                                          Directories

                                                                                          Path Synopsis
                                                                                          internal