AWS API Changes

2023/11/13 - AWS Service Catalog App Registry - 6 updated api methods

Changes When the customer associates a resource collection to their application with this new feature, then a new application tag will be applied to all supported resources that are part of that collection. This allows customers to more easily find the application that is associated with those resources.

AssociateResource (updated)

Link ¶
Changes (both)

{'options': ['APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG']}

Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.

Minimum permissions

You must have the following permissions to associate a resource using the OPTIONS parameter set to APPLY_APPLICATION_TAG .

tag:GetResources
tag:TagResources

You must also have these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.

resource-groups:DisassociateResource
cloudformation:UpdateStack
cloudformation:DescribeStacks

Note

In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference .

See also: AWS API Documentation

Request Syntax

client.associate_resource(
    application='string',
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string',
    options=[
        'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
    ]
)

type application

string

param application

[REQUIRED]

The name, ID, or ARN 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.

type options

list

param options

Determines whether an application tag is applied or skipped.

(string) --

rtype

dict

returns

Response Syntax

{
    'applicationArn': 'string',
    'resourceArn': 'string',
    'options': [
        'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
    ]
}

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.
- options (list) --
  
  Determines whether an application tag is applied or skipped.
  - (string) --

CreateApplication (updated)

Link ¶
Changes (response)

{'application': {'applicationTag': {'string': 'string'}}}

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

See also: AWS API Documentation

Request Syntax

client.create_application(
    name='string',
    description='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)

type name

string

param name

[REQUIRED]

The name of the application. The name must be unique in the region in which you are creating the application.

type description

string

param description

The description of the application.

type tags

dict

param tags

Key-value pairs you can use to associate with the application.

(string) --
- (string) --

type clientToken

string

param clientToken

[REQUIRED]

A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'application': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'applicationTag': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- application (dict) --
  
  Information about the application.
  - id (string) --
    
    The identifier of the application.
  - arn (string) --
    
    The Amazon resource name (ARN) that specifies the application across services.
  - name (string) --
    
    The name of the application. The name must be unique in the region in which you are creating the application.
  - description (string) --
    
    The description of the application.
  - creationTime (datetime) --
    
    The ISO-8601 formatted timestamp of the moment when the application was created.
  - lastUpdateTime (datetime) --
    
    The ISO-8601 formatted timestamp of the moment when the application was last updated.
  - tags (dict) --
    
    Key-value pairs you can use to associate with the application.
    - (string) --
      - (string) --
  - applicationTag (dict) --
    
    A key-value pair that identifies an associated resource.
    - (string) --
      - (string) --

GetApplication (updated)

Link ¶
Changes (response)

{'applicationTag': {'string': 'string'},
 'integrations': {'applicationTagResourceGroup': {'arn': 'string',
                                                  'errorMessage': 'string',
                                                  'state': 'CREATING | '
                                                           'CREATE_COMPLETE | '
                                                           'CREATE_FAILED | '
                                                           'UPDATING | '
                                                           'UPDATE_COMPLETE | '
                                                           'UPDATE_FAILED'}}}

Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

See also: AWS API Documentation

Request Syntax

client.get_application(
    application='string'
)

type application

string

param application

[REQUIRED]

The name, ID, or ARN of the application.

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastUpdateTime': datetime(2015, 1, 1),
    'associatedResourceCount': 123,
    'tags': {
        'string': 'string'
    },
    'integrations': {
        'resourceGroup': {
            'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
            'arn': 'string',
            'errorMessage': 'string'
        },
        'applicationTagResourceGroup': {
            'state': 'CREATING'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
            'arn': 'string',
            'errorMessage': 'string'
        }
    },
    'applicationTag': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- id (string) --
  
  The identifier of the application.
- arn (string) --
  
  The Amazon resource name (ARN) that specifies the application across services.
- name (string) --
  
  The name of the application. The name must be unique in the region in which you are creating the application.
- description (string) --
  
  The description of the application.
- creationTime (datetime) --
  
  The ISO-8601 formatted timestamp of the moment when the application was created.
- lastUpdateTime (datetime) --
  
  The ISO-8601 formatted timestamp of the moment when the application was last updated.
- associatedResourceCount (integer) --
  
  The number of top-level resources that were registered as part of this application.
- tags (dict) --
  
  Key-value pairs associated with the application.
  - (string) --
    - (string) --
- integrations (dict) --
  
  The information about the integration of the application with other services, such as Resource Groups.
  - resourceGroup (dict) --
    
    The information about the resource group integration.
    - 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.
  - applicationTagResourceGroup (dict) --
    
    The information about the resource group integration.
    - 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.
- applicationTag (dict) --
  
  A key-value pair that identifies an associated resource.
  - (string) --
    - (string) --

GetAssociatedResource (updated)

Link ¶
Changes (request, response)
Request

{'maxResults': 'integer',
 'nextToken': 'string',
 'resourceTagStatus': ['SUCCESS | FAILED | IN_PROGRESS | SKIPPED']}

Response

{'applicationTagResult': {'applicationTagStatus': 'IN_PROGRESS | SUCCESS | '
                                                  'FAILURE',
                          'errorMessage': 'string',
                          'nextToken': 'string',
                          'resources': [{'errorMessage': 'string',
                                         'resourceArn': 'string',
                                         'resourceType': 'string',
                                         'status': 'string'}]},
 'options': ['APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG']}

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',
    nextToken='string',
    resourceTagStatus=[
        'SUCCESS'|'FAILED'|'IN_PROGRESS'|'SKIPPED',
    ],
    maxResults=123
)

type application

string

param application

[REQUIRED]

The name, ID, or ARN 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.

type nextToken

string

param nextToken

A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

type resourceTagStatus

list

param resourceTagStatus

States whether an application tag is applied, not applied, in the process of being applied, or skipped.

(string) --

type maxResults

integer

param maxResults

The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.

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'
            }
        }
    },
    'options': [
        'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
    ],
    'applicationTagResult': {
        'applicationTagStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILURE',
        'errorMessage': 'string',
        'resources': [
            {
                'resourceArn': 'string',
                'errorMessage': 'string',
                'status': 'string',
                'resourceType': 'string'
            },
        ],
        'nextToken': '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.
- options (list) --
  
  Determines whether an application tag is applied or skipped.
  - (string) --
- applicationTagResult (dict) --
  
  The result of the application that's tag applied to a resource.
  - applicationTagStatus (string) --
    
    The application tag is in the process of being applied to a resource, was successfully applied to a resource, or failed to apply to a resource.
  - errorMessage (string) --
    
    The message returned if the call fails.
  - resources (list) --
    
    The resources associated with an application
    - (dict) --
      
      The resource in a list of resources.
      - resourceArn (string) --
        
        The Amazon resource name (ARN) of the resource.
      - errorMessage (string) --
        
        The message returned if the call fails.
      - status (string) --
        
        The status of the list item.
      - resourceType (string) --
        
        Provides information about the AppRegistry resource type.
  - nextToken (string) --
    
    A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

ListAssociatedResources (updated)

Link ¶
Changes (response)

{'resources': {'options': ['APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG']}}

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, ID, or ARN 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'
            },
            'options': [
                'APPLY_APPLICATION_TAG'|'SKIP_APPLICATION_TAG',
            ]
        },
    ],
    '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.
    - options (list) --
      
      Determines whether an application tag is applied or skipped.
      - (string) --
- nextToken (string) --
  
  The token to use to get the next page of results after a previous API call.

UpdateApplication (updated)

Link ¶
Changes (response)

{'application': {'applicationTag': {'string': 'string'}}}

Updates an existing application with new attributes.

See also: AWS API Documentation

Request Syntax

client.update_application(
    application='string',
    name='string',
    description='string'
)

type application

string

param application

[REQUIRED]

The name, ID, or ARN of the application that will be updated.

type name

string

param name

Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.

type description

string

param description

The new description of the application.

rtype

dict

returns

Response Syntax

{
    'application': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'applicationTag': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- application (dict) --
  
  The updated information of the application.
  - id (string) --
    
    The identifier of the application.
  - arn (string) --
    
    The Amazon resource name (ARN) that specifies the application across services.
  - name (string) --
    
    The name of the application. The name must be unique in the region in which you are creating the application.
  - description (string) --
    
    The description of the application.
  - creationTime (datetime) --
    
    The ISO-8601 formatted timestamp of the moment when the application was created.
  - lastUpdateTime (datetime) --
    
    The ISO-8601 formatted timestamp of the moment when the application was last updated.
  - tags (dict) --
    
    Key-value pairs you can use to associate with the application.
    - (string) --
      - (string) --
  - applicationTag (dict) --
    
    A key-value pair that identifies an associated resource.
    - (string) --
      - (string) --