ResourceGroups / Client / create_group

create_group#

ResourceGroups.Client.create_group(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    Name='string',
    Description='string',
    ResourceQuery={
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': 'string'
    },
    Tags={
        'string': 'string'
    },
    Configuration=[
        {
            'Type': 'string',
            'Parameters': [
                {
                    'Name': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ]
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the group, which is the identifier of the group in other operations. You can’t change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS, aws, or any other possible capitalization; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.

  • Description (string) – The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.

  • ResourceQuery (dict) –

    The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.

    Note

    A resource group can contain either a ResourceQuery or a Configuration, but not both.

    • Type (string) – [REQUIRED]

      The type of the query to perform. This can have one of two values:

      • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

      • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

    • Query (string) – [REQUIRED]

      The query that defines a group or a search. The contents depends on the value of the Type element.

      • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

        • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

        • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. 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.

      Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

      • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.

        • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

        • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

      The resource query results would not include the following items in the results, however.

      • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

      • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

      Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

      • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

  • Tags (dict) –

    The tags to add to the group. A tag is key-value pair string.

    • (string) –

      • (string) –

  • Configuration (list) –

    A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.

    Note

    A resource group can contain either a Configuration or a ResourceQuery, but not both.

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'GroupArn': 'string',
        'Name': 'string',
        'Description': 'string'
    },
    'ResourceQuery': {
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': 'string'
    },
    'Tags': {
        'string': 'string'
    },
    'GroupConfiguration': {
        'Configuration': [
            {
                'Type': 'string',
                'Parameters': [
                    {
                        'Name': 'string',
                        'Values': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'ProposedConfiguration': [
            {
                'Type': 'string',
                'Parameters': [
                    {
                        'Name': 'string',
                        'Values': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'Status': 'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
        'FailureReason': 'string'
    }
}

Response Structure

  • (dict) –

    • Group (dict) –

      The description of the resource group.

      • GroupArn (string) –

        The ARN of the resource group.

      • Name (string) –

        The name of the resource group.

      • Description (string) –

        The description of the resource group.

    • ResourceQuery (dict) –

      The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.

      • Type (string) –

        The type of the query to perform. This can have one of two values:

        • CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.

        • TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.

      • Query (string) –

        The query that defines a group or a search. The contents depends on the value of the Type element.

        • ResourceTypeFilters – Applies to all ResourceQuery objects of either Type. This element contains one of the following two items:

          • The value AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query.

          • A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. 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.

        Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

        • TagFilters – applicable only if Type = TAG_FILTERS_1_0. The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.

          • An Amazon EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"}

          • An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"}

        The resource query results would not include the following items in the results, however.

        • An Amazon EC2 instance that has only the following tag: {"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.

        • An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.

        Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

        • StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0. The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.

    • Tags (dict) –

      The tags associated with the group.

      • (string) –

        • (string) –

    • GroupConfiguration (dict) –

      The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for Resource Groups.

      • Configuration (list) –

        The configuration currently associated with the group and in effect.

      • ProposedConfiguration (list) –

        If present, the new configuration that is in the process of being applied to the group.

      • Status (string) –

        The current status of an attempt to update the group configuration.

      • FailureReason (string) –

        If present, the reason why a request to update the group configuration failed.

Exceptions

  • ResourceGroups.Client.exceptions.BadRequestException

  • ResourceGroups.Client.exceptions.ForbiddenException

  • ResourceGroups.Client.exceptions.MethodNotAllowedException

  • ResourceGroups.Client.exceptions.TooManyRequestsException

  • ResourceGroups.Client.exceptions.InternalServerErrorException