AWS API Changes

2022/11/17 - AWS Service Catalog App Registry - 2 new 5 updated api methods

Changes This release adds support for tagged resource associations, which allows you to associate a group of resources with a defined resource tag key and value to the application.

GetConfiguration (new)

Link ¶

Retrieves a TagKey configuration from an account.

See also: AWS API Documentation

Request Syntax

client.get_configuration()

rtype

dict

returns

Response Syntax

{
    'configuration': {
        'tagQueryConfiguration': {
            'tagKey': 'string'
        }
    }
}

Response Structure

(dict) --
- configuration (dict) --
  
  Retrieves TagKey configuration from an account.
  - tagQueryConfiguration (dict) --
    
    Includes the definition of a tagQuery .
    - tagKey (string) --
      
      Condition in the IAM policy that associates resources to an application.

PutConfiguration (new)

Link ¶

Associates a TagKey configuration to an account.

See also: AWS API Documentation

Request Syntax

client.put_configuration(
    configuration={
        'tagQueryConfiguration': {
            'tagKey': 'string'
        }
    }
)

type configuration

dict

param configuration

[REQUIRED]

Associates a TagKey configuration to an account.

tagQueryConfiguration (dict) --

Includes the definition of a tagQuery .
- tagKey (string) --
  
  Condition in the IAM policy that associates resources to an application.

returns

None

AssociateResource (updated)

Link ¶
Changes (request)

{'resourceType': {'RESOURCE_TAG_VALUE'}}

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

See also: AWS API Documentation

Request Syntax

client.associate_resource(
    application='string',
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string'
)

type application

string

param application

[REQUIRED]

The name or ID of the application.

type resourceType

string

param resourceType

[REQUIRED]

The type of resource of which the application will be associated.

type resource

string

param resource

[REQUIRED]

The name or ID of the resource of which the application will be associated.

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'resourceArn': 'string'
}

Response Structure

(dict) --
- applicationArn (string) --
  
  The Amazon resource name (ARN) of the application that was augmented with attributes.
- resourceArn (string) --
  
  The Amazon resource name (ARN) that specifies the resource.

DisassociateResource (updated)

Link ¶
Changes (request)

{'resourceType': {'RESOURCE_TAG_VALUE'}}

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

See also: AWS API Documentation

Request Syntax

client.disassociate_resource(
    application='string',
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string'
)

type application

string

param application

[REQUIRED]

The name or ID of the application.

type resourceType

string

param resourceType

[REQUIRED]

The type of the resource that is being disassociated.

type resource

string

param resource

[REQUIRED]

The name or ID of the resource.

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'resourceArn': 'string'
}

Response Structure

(dict) --
- applicationArn (string) --
  
  The Amazon resource name (ARN) that specifies the application.
- resourceArn (string) --
  
  The Amazon resource name (ARN) that specifies the resource.

GetAssociatedResource (updated)

Link ¶
Changes (request)

{'resourceType': {'RESOURCE_TAG_VALUE'}}

Gets the resource associated with the application.

See also: AWS API Documentation

Request Syntax

client.get_associated_resource(
    application='string',
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string'
)

type application

string

param application

[REQUIRED]

The name or ID of the application.

type resourceType

string

param resourceType

[REQUIRED]

The type of resource associated with the application.

type resource

string

param resource

[REQUIRED]

The name or ID of the resource associated with the application.

rtype

dict

returns

Response Syntax

{
    'resource': {
        'name': 'string',
        'arn': 'string',
        'associationTime': datetime(2015, 1, 1),
        'integrations': {
            'resourceGroup': {
                'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
                'arn': 'string',
                'errorMessage': 'string'
            }
        }
    }
}

Response Structure

(dict) --
- resource (dict) --
  
  The resource associated with the application.
  - name (string) --
    
    The name of the resource.
  - arn (string) --
    
    The Amazon resource name (ARN) of the resource.
  - associationTime (datetime) --
    
    The time the resource was associated with the application.
  - integrations (dict) --
    
    The service integration information about the resource.
    - resourceGroup (dict) --
      
      The information about the integration of Resource Groups.
      - state (string) --
        
        The state of the propagation process for the resource group. The states includes:
        
        CREATING if the resource group is in the process of being created.
        
        CREATE_COMPLETE if the resource group was created successfully.
        
        CREATE_FAILED if the resource group failed to be created.
        
        UPDATING if the resource group is in the process of being updated.
        
        UPDATE_COMPLETE if the resource group updated successfully.
        
        UPDATE_FAILED if the resource group could not update successfully.
      - arn (string) --
        
        The Amazon resource name (ARN) of the resource group.
      - errorMessage (string) --
        
        The error message that generates when the propagation process for the resource group fails.

ListAssociatedResources (updated)

Link ¶
Changes (response)

{'resources': {'resourceDetails': {'tagValue': 'string'},
               'resourceType': 'CFN_STACK | RESOURCE_TAG_VALUE'}}

Lists all of the resources that are associated with the specified application. Results are paginated.

Note

If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

See also: AWS API Documentation

Request Syntax

client.list_associated_resources(
    application='string',
    nextToken='string',
    maxResults=123
)

type application

string

param application

[REQUIRED]

The name or ID of the application.

type nextToken

string

param nextToken

The token to use to get the next page of results after a previous API call.

type maxResults

integer

param maxResults

The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

rtype

dict

returns

Response Syntax

{
    'resources': [
        {
            'name': 'string',
            'arn': 'string',
            'resourceType': 'CFN_STACK'|'RESOURCE_TAG_VALUE',
            'resourceDetails': {
                'tagValue': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- resources (list) --
  
  Information about the resources.
  - (dict) --
    
    The information about the resource.
    - name (string) --
      
      The name of the resource.
    - arn (string) --
      
      The Amazon resource name (ARN) that specifies the resource across services.
    - resourceType (string) --
      
      Provides information about the Service Catalog App Registry resource type.
    - resourceDetails (dict) --
      
      The details related to the resource.
      - tagValue (string) --
        
        The value of the tag.
- nextToken (string) --
  
  The token to use to get the next page of results after a previous API call.

SyncResource (updated)

Link ¶
Changes (request)

{'resourceType': {'RESOURCE_TAG_VALUE'}}

Syncs the resource with current AppRegistry records.

Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.

See also: AWS API Documentation

Request Syntax

client.sync_resource(
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string'
)

type resourceType

string

param resourceType

[REQUIRED]

The type of resource of which the application will be associated.

type resource

string

param resource

[REQUIRED]

An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'resourceArn': 'string',
    'actionTaken': 'START_SYNC'|'NO_ACTION'
}

Response Structure

(dict) --
- applicationArn (string) --
  
  The Amazon resource name (ARN) that specifies the application.
- resourceArn (string) --
  
  The Amazon resource name (ARN) that specifies the resource.
- actionTaken (string) --
  
  The results of the output if an application is associated with an ARN value, which could be syncStarted or None.