Module Awso_resource_groups.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.

Sourcemodule Query : sig ... end
Sourcemodule QueryType : sig ... end
Sourcemodule ApplicationArn : sig ... end
Sourcemodule ApplicationTagKey : sig ... end
Sourcemodule GroupFilterValue : sig ... end
Sourcemodule ResourceArn : sig ... end
Sourcemodule ResourceType : sig ... end
Sourcemodule ResourceStatusValue : sig ... end
Sourcemodule ResourceFilterValue : sig ... end
Sourcemodule GroupConfigurationType : sig ... end
Sourcemodule GroupParameterList : sig ... end
Sourcemodule ErrorCode : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule QueryErrorCode : sig ... end
Sourcemodule QueryErrorMessage : sig ... end
Sourcemodule GroupArnV2 : sig ... end
Sourcemodule GroupName : sig ... end
Sourcemodule ResourceQuery : sig ... end

The query you can use to define a resource group or a search for resources. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. See the examples section for example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (\). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example: --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}' In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide. For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example: "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]

Sourcemodule RoleArn : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagSyncTaskArn : sig ... end
Sourcemodule TagSyncTaskStatus : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule Criticality : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule DisplayName : sig ... end
Sourcemodule GroupArn : sig ... end
Sourcemodule Owner : sig ... end
Sourcemodule ApplicationTag : sig ... end
Sourcemodule GroupFilterName : sig ... end
Sourcemodule GroupFilterValues : sig ... end
Sourcemodule GroupingStatus : sig ... end
Sourcemodule GroupingType : sig ... end
Sourcemodule ResourceIdentifier : sig ... end

A structure that contains the ARN of a resource and its resource type.

Sourcemodule ResourceStatus : sig ... end

A structure that identifies the current group membership status for a resource. Adding a resource to a resource group is performed asynchronously as a background task. A PENDING status indicates, for this resource, that the process isn't completed yet.

Sourcemodule ResourceFilterName : sig ... end
Sourcemodule ResourceFilterValues : sig ... end
Sourcemodule GroupConfigurationItem : sig ... end

An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.

Sourcemodule FailedResource : sig ... end

A resource that failed to be added to or removed from a group.

Sourcemodule PendingResource : sig ... end

A structure that identifies a resource that is currently pending addition to the group as a member. Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.

Sourcemodule QueryError : sig ... end

A two-part error structure that can occur in ListGroupResources or SearchResources.

Sourcemodule TagSyncTaskItem : sig ... end

The Amazon resource name (ARN) of the tag-sync task.

Sourcemodule ListTagSyncTasksFilter : sig ... end

Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a specified application group.

Sourcemodule GroupIdentifier : sig ... end

The unique identifiers for a resource group.

Sourcemodule Group : sig ... end

A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group: ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation. GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.

Sourcemodule GroupFilter : sig ... end

A filter collection that you can use to restrict the results from a List operation to only those you want to include.

Sourcemodule GroupingStatusesItem : sig ... end

The information about a grouping or ungrouping resource action.

A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.

Sourcemodule ListGroupResourcesItem : sig ... end

A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.

Sourcemodule ResourceFilter : sig ... end

A filter name and value pair that is used to obtain more specific results from a list of resources.

Sourcemodule GroupConfigurationList : sig ... end
Sourcemodule GroupConfigurationStatus : sig ... end
Sourcemodule BadRequestException : sig ... end

The request includes one or more parameters that violate validation rules.

Sourcemodule ForbiddenException : sig ... end

The caller isn't authorized to make the request. Check permissions.

Sourcemodule GroupQuery : sig ... end

A mapping of a query attached to a resource group that determines the Amazon Web Services resources that are members of the group.

An internal error occurred while processing the request. Try again later.

Sourcemodule MethodNotAllowedException : sig ... end

The request uses an HTTP method that isn't allowed for the specified resource.

Sourcemodule NotFoundException : sig ... end

One or more of the specified resources don't exist.

Sourcemodule TooManyRequestsException : sig ... end

You've exceeded throttling limits by making too many requests in a period of time.

Sourcemodule GroupString : sig ... end
Sourcemodule GroupStringV2 : sig ... end
Sourcemodule AccountSettings : sig ... end

The Resource Groups settings for this Amazon Web Services account.

Sourcemodule TagKeyList : sig ... end
Sourcemodule FailedResourceList : sig ... end
Sourcemodule PendingResourceList : sig ... end
Sourcemodule ResourceArnList : sig ... end
Sourcemodule Tags : sig ... end
Sourcemodule UnauthorizedException : sig ... end

The request was rejected because it doesn't have valid credentials for the target resource.

Sourcemodule NextToken : sig ... end
Sourcemodule QueryErrorList : sig ... end
Sourcemodule ResourceIdentifierList : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule TagSyncTaskList : sig ... end
Sourcemodule GroupIdentifierList : sig ... end
Sourcemodule GroupList : sig ... end
Sourcemodule GroupFilterList : sig ... end
Sourcemodule GroupingStatusesList : sig ... end
Sourcemodule ResourceFilterList : sig ... end
Sourcemodule GroupConfiguration : sig ... end

A service configuration associated with a resource group. The configuration options are determined by the Amazon Web Services service that defines the Type, and specifies which resources can be included in the group. You can add a service configuration when you create the group by using CreateGroup, or later by using the PutGroupConfiguration operation. For details about group service configuration syntax, see Service configurations for resource groups.

Sourcemodule CreateGroupName : sig ... end
Sourcemodule UpdateGroupQueryOutput : sig ... end

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery

Sourcemodule UpdateGroupQueryInput : sig ... end

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroupQuery

Sourcemodule UpdateGroupOutput : sig ... end

Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroup

Sourcemodule UpdateGroupInput : sig ... end

Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UpdateGroup

Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

Sourcemodule UntagOutput : sig ... end

Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:Untag

Sourcemodule UntagInput : sig ... end

Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:Untag

Sourcemodule UngroupResourcesOutput : sig ... end

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: resource-groups:UngroupResources

Sourcemodule UngroupResourcesInput : sig ... end

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: resource-groups:UngroupResources

Sourcemodule TagOutput : sig ... end

Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters. 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 To run this command, you must have the following permissions: resource-groups:Tag

Sourcemodule TagInput : sig ... end

Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters. 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 To run this command, you must have the following permissions: resource-groups:Tag

Sourcemodule StartTagSyncTaskOutput : sig ... end

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide. Minimum permissions To run this command, you must have the following permissions: resource-groups:StartTagSyncTask on the application group resource-groups:CreateGroup iam:PassRole on the role provided in the request

Sourcemodule StartTagSyncTaskInput : sig ... end

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the Amazon Web Services Service Catalog AppRegistry Administrator Guide. Minimum permissions To run this command, you must have the following permissions: resource-groups:StartTagSyncTask on the application group resource-groups:CreateGroup iam:PassRole on the role provided in the request

Sourcemodule SearchResourcesOutput : sig ... end

Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:SearchResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources

Sourcemodule SearchResourcesInput : sig ... end

Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:SearchResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration

Sourcemodule ListTagSyncTasksOutput : sig ... end

Returns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters

Sourcemodule ListTagSyncTasksInput : sig ... end

Returns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters

Sourcemodule ListGroupsOutput : sig ... end

Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroups

Sourcemodule ListGroupsInput : sig ... end

Returns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroups

Returns the status of the last grouping or ungrouping action for each resource in the specified application group.

Sourcemodule ListGroupingStatusesInput : sig ... end

Returns the status of the last grouping or ungrouping action for each resource in the specified application group.

Sourcemodule ListGroupResourcesOutput : sig ... end

Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroupResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources

Sourcemodule ListGroupResourcesInput : sig ... end

Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroupResources cloudformation:DescribeStacks cloudformation:ListStackResources tag:GetResources

Sourcemodule GroupResourcesOutput : sig ... end

Adds the specified resources to the specified group. You can only use this operation with the following groups: AWS::EC2::HostManagement AWS::EC2::CapacityReservationPool AWS::ResourceGroups::ApplicationGroup Other resource group types and resource types are not currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:GroupResources

Sourcemodule GroupResourcesInput : sig ... end

Adds the specified resources to the specified group. You can only use this operation with the following groups: AWS::EC2::HostManagement AWS::EC2::CapacityReservationPool AWS::ResourceGroups::ApplicationGroup Other resource group types and resource types are not currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:GroupResources

Sourcemodule GetTagsOutput : sig ... end

Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN). Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTags

Sourcemodule GetTagsInput : sig ... end

Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN). Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTags

Sourcemodule GetTagSyncTaskOutput : sig ... end

Returns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTagSyncTask on the application group

Sourcemodule GetTagSyncTaskInput : sig ... end

Returns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTagSyncTask on the application group

Sourcemodule GetGroupQueryOutput : sig ... end

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupQuery

Sourcemodule GetGroupQueryInput : sig ... end

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupQuery

Sourcemodule GetGroupOutput : sig ... end

Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroup

Sourcemodule GetGroupInput : sig ... end

Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroup

Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration

Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration

Sourcemodule GetAccountSettingsOutput : sig ... end

Retrieves the current status of optional features in Resource Groups.

Sourcemodule DeleteGroupOutput : sig ... end

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: resource-groups:DeleteGroup

Sourcemodule DeleteGroupInput : sig ... end

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions: resource-groups:DeleteGroup

Sourcemodule CreateGroupOutput : sig ... end

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:CreateGroup

Sourcemodule CreateGroupInput : sig ... end

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:CreateGroup

Sourcemodule CancelTagSyncTaskInput : sig ... end

Cancels the specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:CancelTagSyncTask on the application group resource-groups:DeleteGroup