AWS API Changes

2018/11/14 - AWS Resource Groups - 5 updated api methods

Changes The AWS Resource Groups service added support for AWS CloudFormation stack-based groups.

CreateGroup (updated)

Link ¶
Changes (both)

{'ResourceQuery': {'Type': ['CLOUDFORMATION_STACK_1_0']}}

Creates a group with a specified name, description, and resource query.

See also: AWS API Documentation

Request Syntax

client.create_group(
    Name='string',
    Description='string',
    ResourceQuery={
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': 'string'
    },
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

[REQUIRED]

The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws ; these are reserved. A resource group name must be unique within your account.

type Description

string

param Description

The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.

type ResourceQuery

dict

param ResourceQuery

[REQUIRED]

The resource query that determines which AWS resources are members of this group.

Type (string) -- [REQUIRED]

The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
- An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
- An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
- An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) -- [REQUIRED]

The query that defines a group or a search.

type Tags

dict

param Tags

The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

(string) --
- (string) --

rtype

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'
    }
}

Response Structure

(dict) --
- Group (dict) --
  
  A full description of the resource group after it is created.
  - GroupArn (string) --
    
    The ARN of a resource group.
  - Name (string) --
    
    The name of a resource group.
  - Description (string) --
    
    The description of the resource group.
- ResourceQuery (dict) --
  
  The resource query associated with the group.
  - Type (string) --
    
    The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
    - TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
    - An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
    - An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
    The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
    - An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
    - An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
    - CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
  - Query (string) --
    
    The query that defines a group or a search.
- Tags (dict) --
  
  The tags associated with the group.
  - (string) --
    - (string) --

GetGroupQuery (updated)

Link ¶
Changes (response)

{'GroupQuery': {'ResourceQuery': {'Type': ['CLOUDFORMATION_STACK_1_0']}}}

Returns the resource query associated with the specified resource group.

See also: AWS API Documentation

Request Syntax

client.get_group_query(
    GroupName='string'
)

type GroupName

string

param GroupName

[REQUIRED]

The name of the resource group.

rtype

dict

returns

Response Syntax

{
    'GroupQuery': {
        'GroupName': 'string',
        'ResourceQuery': {
            'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
            'Query': 'string'
        }
    }
}

Response Structure

(dict) --
- GroupQuery (dict) --
  
  The resource query associated with the specified group.
  - GroupName (string) --
    
    The name of a resource group that is associated with a specific resource query.
  - ResourceQuery (dict) --
    
    The resource query which determines which AWS resources are members of the associated resource group.
    - Type (string) --
      
      The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
      TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
      - An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
      - An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
      The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
      - An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
      - An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
      CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
    - Query (string) --
      
      The query that defines a group or a search.

ListGroupResources (updated)

Link ¶
Changes (response)

{'QueryErrors': [{'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE | '
                               'CLOUDFORMATION_STACK_NOT_EXISTING',
                  'Message': 'string'}]}

Returns a list of ARNs of resources that are members of a specified resource group.

See also: AWS API Documentation

Request Syntax

client.list_group_resources(
    GroupName='string',
    Filters=[
        {
            'Name': 'resource-type',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type GroupName

string

param GroupName

[REQUIRED]

The name of the resource group.

type Filters

list

param Filters

Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.

resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

(dict) --

A filter name and value pair that is used to obtain more specific results from a list of resources.
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50.

type NextToken

string

param NextToken

The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

rtype

dict

returns

Response Syntax

{
    'ResourceIdentifiers': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'string'
        },
    ],
    'NextToken': 'string',
    'QueryErrors': [
        {
            'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) --
- ResourceIdentifiers (list) --
  
  The ARNs and resource types of resources that are members of the group that you specified.
  - (dict) --
    
    The ARN of a resource, and its resource type.
    - ResourceArn (string) --
      
      The ARN of a resource.
    - ResourceType (string) --
      
      The resource type of a resource, such as AWS::EC2::Instance .
- NextToken (string) --
  
  The NextToken value to include in a subsequent ListGroupResources request, to get more results.
- QueryErrors (list) --
  
  A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
  - (dict) --
    
    A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFormation stack-based queries. The error occurs if the CloudFormation stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
    - ErrorCode (string) --
      
      Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
    - Message (string) --
      
      A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .

SearchResources (updated)

Link ¶
Changes (request, response)
Request

{'ResourceQuery': {'Type': ['CLOUDFORMATION_STACK_1_0']}}

Response

{'QueryErrors': [{'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE | '
                               'CLOUDFORMATION_STACK_NOT_EXISTING',
                  'Message': 'string'}]}

Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

See also: AWS API Documentation

Request Syntax

client.search_resources(
    ResourceQuery={
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': 'string'
    },
    MaxResults=123,
    NextToken='string'
)

type ResourceQuery

dict

param ResourceQuery

[REQUIRED]

The search query, using the same formats that are supported for resource group definition.

Type (string) -- [REQUIRED]

The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
- An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
- An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
- An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) -- [REQUIRED]

The query that defines a group or a search.

type MaxResults

integer

param MaxResults

The maximum number of group member ARNs returned by SearchResources in paginated output. By default, this number is 50.

type NextToken

string

param NextToken

The NextToken value that is returned in a paginated SearchResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

rtype

dict

returns

Response Syntax

{
    'ResourceIdentifiers': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'string'
        },
    ],
    'NextToken': 'string',
    'QueryErrors': [
        {
            'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING',
            'Message': 'string'
        },
    ]
}

Response Structure

(dict) --
- ResourceIdentifiers (list) --
  
  The ARNs and resource types of resources that are members of the group that you specified.
  - (dict) --
    
    The ARN of a resource, and its resource type.
    - ResourceArn (string) --
      
      The ARN of a resource.
    - ResourceType (string) --
      
      The resource type of a resource, such as AWS::EC2::Instance .
- NextToken (string) --
  
  The NextToken value to include in a subsequent SearchResources request, to get more results.
- QueryErrors (list) --
  
  A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
  - (dict) --
    
    A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFormation stack-based queries. The error occurs if the CloudFormation stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
    - ErrorCode (string) --
      
      Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
    - Message (string) --
      
      A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .

UpdateGroupQuery (updated)

Link ¶
Changes (request, response)
Request

{'ResourceQuery': {'Type': ['CLOUDFORMATION_STACK_1_0']}}

Response

{'GroupQuery': {'ResourceQuery': {'Type': ['CLOUDFORMATION_STACK_1_0']}}}

Updates the resource query of a group.

See also: AWS API Documentation

Request Syntax

client.update_group_query(
    GroupName='string',
    ResourceQuery={
        'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
        'Query': 'string'
    }
)

type GroupName

string

param GroupName

[REQUIRED]

The name of the resource group for which you want to edit the query.

type ResourceQuery

dict

param ResourceQuery

[REQUIRED]

The resource query that determines which AWS resources are members of the resource group.

Type (string) -- [REQUIRED]

The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
- An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
- An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
- An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) -- [REQUIRED]

The query that defines a group or a search.

rtype

dict

returns

Response Syntax

{
    'GroupQuery': {
        'GroupName': 'string',
        'ResourceQuery': {
            'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
            'Query': 'string'
        }
    }
}

Response Structure

(dict) --
- GroupQuery (dict) --
  
  The resource query associated with the resource group after the update.
  - GroupName (string) --
    
    The name of a resource group that is associated with a specific resource query.
  - ResourceQuery (dict) --
    
    The resource query which determines which AWS resources are members of the associated resource group.
    - Type (string) --
      
      The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
      TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
      - An EC2 instance that has the following two tags: {"Key":"Stage","Values":["Deploy"]} , and {"Key":"Version","Values":["2"]}
      - An S3 bucket that has the following two tags: {"Key":"Stage","Values":["Test","Deploy"]}, and {"Key":"Version","Values":["1"]}
      The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
      - An EC2 instance that has only the following tag: {"Key":"Stage","Values":["Deploy"]} .
      - An RDS database that has the following two tags: {"Key":"Stage","Values":["Archived"]} , and {"Key":"Version","Values":["4"]}
      CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
    - Query (string) --
      
      The query that defines a group or a search.