Table of Contents
AppRegistry.Client¶A low-level client representing AWS Service Catalog App Registry (AppRegistry)
Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.
import boto3
client = boto3.client('servicecatalog-appregistry')
These are the available methods:
associate_attribute_group()associate_resource()can_paginate()close()create_application()create_attribute_group()delete_application()delete_attribute_group()disassociate_attribute_group()disassociate_resource()get_application()get_associated_resource()get_attribute_group()get_configuration()get_paginator()get_waiter()list_applications()list_associated_attribute_groups()list_associated_resources()list_attribute_groups()list_attribute_groups_for_application()list_tags_for_resource()put_configuration()sync_resource()tag_resource()untag_resource()update_application()update_attribute_group()associate_attribute_group(**kwargs)¶Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.
See also: AWS API Documentation
Request Syntax
response = client.associate_attribute_group(
application='string',
attributeGroup='string'
)
[REQUIRED]
The name or ID of the application.
[REQUIRED]
The name or ID of the attribute group that holds the attributes to describe the application.
dict
Response Syntax
{
'applicationArn': 'string',
'attributeGroupArn': 'string'
}
Response Structure
(dict) --
applicationArn (string) --
The Amazon resource name (ARN) of the application that was augmented with attributes.
attributeGroupArn (string) --
The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ServiceQuotaExceededExceptionAppRegistry.Client.exceptions.ConflictExceptionassociate_resource(**kwargs)¶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
response = client.associate_resource(
application='string',
resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
resource='string'
)
[REQUIRED]
The name or ID of the application.
[REQUIRED]
The type of resource of which the application will be associated.
[REQUIRED]
The name or ID of the resource of which the application will be associated.
dict
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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ServiceQuotaExceededExceptionAppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.ValidationExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_application(**kwargs)¶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
response = client.create_application(
name='string',
description='string',
tags={
'string': 'string'
},
clientToken='string'
)
[REQUIRED]
The name of the application. The name must be unique in the region in which you are creating the application.
Key-value pairs you can use to associate with the application.
[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.
dict
Response Syntax
{
'application': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'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.
Exceptions
AppRegistry.Client.exceptions.ServiceQuotaExceededExceptionAppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ValidationExceptioncreate_attribute_group(**kwargs)¶Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.
See also: AWS API Documentation
Request Syntax
response = client.create_attribute_group(
name='string',
description='string',
attributes='string',
tags={
'string': 'string'
},
clientToken='string'
)
[REQUIRED]
The name of the attribute group.
[REQUIRED]
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
Key-value pairs you can use to associate with the attribute group.
[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.
dict
Response Syntax
{
'attributeGroup': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
attributeGroup (dict) --
Information about the attribute group.
id (string) --
The globally unique attribute group identifier of the attribute group.
arn (string) --
The Amazon resource name (ARN) that specifies the attribute group across services.
name (string) --
The name of the attribute group.
description (string) --
The description of the attribute group that the user provides.
creationTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was created.
lastUpdateTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
tags (dict) --
Key-value pairs you can use to associate with the attribute group.
Exceptions
AppRegistry.Client.exceptions.ServiceQuotaExceededExceptionAppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptiondelete_application(**kwargs)¶Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application.
See also: AWS API Documentation
Request Syntax
response = client.delete_application(
application='string'
)
[REQUIRED]
The name or ID of the application.
{
'application': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
Information about the deleted application.
The identifier of the application.
The Amazon resource name (ARN) that specifies the application across services.
The name of the application. The name must be unique in the region in which you are creating the application.
The description of the application.
The ISO-8601 formatted timestamp of the moment when the application was created.
The ISO-8601 formatted timestamp of the moment when the application was last updated.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptiondelete_attribute_group(**kwargs)¶Deletes an attribute group, specified either by its attribute group ID or name.
See also: AWS API Documentation
Request Syntax
response = client.delete_attribute_group(
attributeGroup='string'
)
[REQUIRED]
The name or ID of the attribute group that holds the attributes to describe the application.
{
'attributeGroup': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
}
}
Response Structure
Information about the deleted attribute group.
The globally unique attribute group identifier of the attribute group.
The Amazon resource name (ARN) that specifies the attribute group across services.
The name of the attribute group.
The description of the attribute group that the user provides.
The ISO-8601 formatted timestamp of the moment the attribute group was created.
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptiondisassociate_attribute_group(**kwargs)¶Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_attribute_group(
application='string',
attributeGroup='string'
)
[REQUIRED]
The name or ID of the application.
[REQUIRED]
The name or ID of the attribute group that holds the attributes to describe the application.
dict
Response Syntax
{
'applicationArn': 'string',
'attributeGroupArn': 'string'
}
Response Structure
(dict) --
applicationArn (string) --
The Amazon resource name (ARN) that specifies the application.
attributeGroupArn (string) --
The Amazon resource name (ARN) that specifies the attribute group.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptiondisassociate_resource(**kwargs)¶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
response = client.disassociate_resource(
application='string',
resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
resource='string'
)
[REQUIRED]
The name or ID of the application.
[REQUIRED]
The type of the resource that is being disassociated.
[REQUIRED]
The name or ID of the resource.
dict
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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ValidationExceptionget_application(**kwargs)¶Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by 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
response = client.get_application(
application='string'
)
[REQUIRED]
The name or ID of the application.
{
'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'
}
}
}
Response Structure
The identifier of the application.
The Amazon resource name (ARN) that specifies the application across services.
The name of the application. The name must be unique in the region in which you are creating the application.
The description of the application.
The ISO-8601 formatted timestamp of the moment when the application was created.
The ISO-8601 formatted timestamp of the moment when the application was last updated.
The number of top-level resources that were registered as part of this application.
Key-value pairs associated with the application.
The information about the integration of the application with other services, such as Resource Groups.
The information about the resource group integration.
The state of the propagation process for the resource group. The states includes:
CREATINGif the resource group is in the process of being created.
CREATE_COMPLETEif the resource group was created successfully.
CREATE_FAILEDif the resource group failed to be created.
UPDATINGif the resource group is in the process of being updated.
UPDATE_COMPLETEif the resource group updated successfully.
UPDATE_FAILEDif the resource group could not update successfully.
The Amazon resource name (ARN) of the resource group.
The error message that generates when the propagation process for the resource group fails.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ConflictExceptionget_associated_resource(**kwargs)¶Gets the resource associated with the application.
See also: AWS API Documentation
Request Syntax
response = client.get_associated_resource(
application='string',
resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
resource='string'
)
[REQUIRED]
The name or ID of the application.
[REQUIRED]
The type of resource associated with the application.
[REQUIRED]
The name or ID of the resource associated with the application.
dict
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:
CREATINGif the resource group is in the process of being created.
CREATE_COMPLETEif the resource group was created successfully.
CREATE_FAILEDif the resource group failed to be created.
UPDATINGif the resource group is in the process of being updated.
UPDATE_COMPLETEif the resource group updated successfully.
UPDATE_FAILEDif 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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionget_attribute_group(**kwargs)¶Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.
See also: AWS API Documentation
Request Syntax
response = client.get_attribute_group(
attributeGroup='string'
)
[REQUIRED]
The name or ID of the attribute group that holds the attributes to describe the application.
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'attributes': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
The identifier of the attribute group.
The Amazon resource name (ARN) that specifies the attribute group across services.
The name of the attribute group.
The description of the attribute group that the user provides.
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
The ISO-8601 formatted timestamp of the moment the attribute group was created.
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
Key-value pairs associated with the attribute group.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ConflictExceptionget_configuration()¶Retrieves a TagKey configuration from an account.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration()
{
'configuration': {
'tagQueryConfiguration': {
'tagKey': 'string'
}
}
}
Response Structure
Retrieves TagKey configuration from an account.
Includes the definition of a tagQuery .
Condition in the IAM policy that associates resources to an application.
Exceptions
AppRegistry.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_applications(**kwargs)¶Retrieves a list of all of your applications. Results are paginated.
See also: AWS API Documentation
Request Syntax
response = client.list_applications(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'applications': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
applications (list) --
This list of applications.
(dict) --
Summary of a Amazon Web Services Service Catalog AppRegistry 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.
nextToken (string) --
The token to use to get the next page of results after a previous API call.
Exceptions
AppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionlist_associated_attribute_groups(**kwargs)¶Lists all attribute groups that are associated with specified application. Results are paginated.
See also: AWS API Documentation
Request Syntax
response = client.list_associated_attribute_groups(
application='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The name or ID of the application.
dict
Response Syntax
{
'attributeGroups': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
attributeGroups (list) --
A list of attribute group IDs.
nextToken (string) --
The token to use to get the next page of results after a previous API call.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionlist_associated_resources(**kwargs)¶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
response = client.list_associated_resources(
application='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The name or ID of the application.
dict
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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionlist_attribute_groups(**kwargs)¶Lists all attribute groups which you have access to. Results are paginated.
See also: AWS API Documentation
Request Syntax
response = client.list_attribute_groups(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'attributeGroups': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
attributeGroups (list) --
This list of attribute groups.
(dict) --
Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.
id (string) --
The globally unique attribute group identifier of the attribute group.
arn (string) --
The Amazon resource name (ARN) that specifies the attribute group across services.
name (string) --
The name of the attribute group.
description (string) --
The description of the attribute group that the user provides.
creationTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was created.
lastUpdateTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
nextToken (string) --
The token to use to get the next page of results after a previous API call.
Exceptions
AppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionlist_attribute_groups_for_application(**kwargs)¶Lists the details of all attribute groups associated with a specific application. The results display in pages.
See also: AWS API Documentation
Request Syntax
response = client.list_attribute_groups_for_application(
application='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The name or ID of the application.
dict
Response Syntax
{
'attributeGroupsDetails': [
{
'id': 'string',
'arn': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
attributeGroupsDetails (list) --
The details related to a specific attribute group.
(dict) --
The details related to a specific AttributeGroup.
id (string) --
The unique identifier of the attribute group.
arn (string) --
The Amazon resource name (ARN) that specifies the attribute group.
name (string) --
Warning
This field is no longer supported. We recommend you don't use the field when using ListAttributeGroupsForApplication .
The name of the attribute group.
nextToken (string) --
The token to use to get the next page of results after a previous API call.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionLists all of the tags on the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon resource name (ARN) that specifies the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags on the resource.
Exceptions
AppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionput_configuration(**kwargs)¶Associates a TagKey configuration to an account.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration(
configuration={
'tagQueryConfiguration': {
'tagKey': 'string'
}
}
)
[REQUIRED]
Associates a TagKey configuration to an account.
Includes the definition of a tagQuery .
Condition in the IAM policy that associates resources to an application.
Exceptions
AppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ValidationExceptionsync_resource(**kwargs)¶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
response = client.sync_resource(
resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
resource='string'
)
[REQUIRED]
The type of resource of which the application will be associated.
[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.
dict
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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionAppRegistry.Client.exceptions.ConflictExceptiontag_resource(**kwargs)¶Assigns one or more tags (key-value pairs) to the specified resource.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
This operation returns an empty response if the call was successful.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon resource name (ARN) that specifies the resource.
[REQUIRED]
The new or modified tags for the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
AppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionuntag_resource(**kwargs)¶Removes tags from a resource.
This operation returns an empty response if the call was successful.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon resource name (ARN) that specifies the resource.
[REQUIRED]
A list of the tag keys to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
AppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.InternalServerExceptionupdate_application(**kwargs)¶Updates an existing application with new attributes.
See also: AWS API Documentation
Request Syntax
response = client.update_application(
application='string',
name='string',
description='string'
)
[REQUIRED]
The name or ID of the application that will be updated.
dict
Response Syntax
{
'application': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'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.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.InternalServerExceptionupdate_attribute_group(**kwargs)¶Updates an existing attribute group with new details.
See also: AWS API Documentation
Request Syntax
response = client.update_attribute_group(
attributeGroup='string',
name='string',
description='string',
attributes='string'
)
[REQUIRED]
The name or ID of the attribute group that holds the attributes to describe the application.
dict
Response Syntax
{
'attributeGroup': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
attributeGroup (dict) --
The updated information of the attribute group.
id (string) --
The globally unique attribute group identifier of the attribute group.
arn (string) --
The Amazon resource name (ARN) that specifies the attribute group across services.
name (string) --
The name of the attribute group.
description (string) --
The description of the attribute group that the user provides.
creationTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was created.
lastUpdateTime (datetime) --
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
tags (dict) --
Key-value pairs you can use to associate with the attribute group.
Exceptions
AppRegistry.Client.exceptions.ResourceNotFoundExceptionAppRegistry.Client.exceptions.ValidationExceptionAppRegistry.Client.exceptions.ConflictExceptionAppRegistry.Client.exceptions.InternalServerExceptionThe available paginators are:
AppRegistry.Paginator.ListApplicationsAppRegistry.Paginator.ListAssociatedAttributeGroupsAppRegistry.Paginator.ListAssociatedResourcesAppRegistry.Paginator.ListAttributeGroupsAppRegistry.Paginator.ListAttributeGroupsForApplicationAppRegistry.Paginator.ListApplications¶paginator = client.get_paginator('list_applications')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppRegistry.Client.list_applications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'applications': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
This list of applications.
Summary of a Amazon Web Services Service Catalog AppRegistry application.
The identifier of the application.
The Amazon resource name (ARN) that specifies the application across services.
The name of the application. The name must be unique in the region in which you are creating the application.
The description of the application.
The ISO-8601 formatted timestamp of the moment when the application was created.
The ISO-8601 formatted timestamp of the moment when the application was last updated.
A token to resume pagination.
AppRegistry.Paginator.ListAssociatedAttributeGroups¶paginator = client.get_paginator('list_associated_attribute_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppRegistry.Client.list_associated_attribute_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
application='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or ID of the application.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'attributeGroups': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
attributeGroups (list) --
A list of attribute group IDs.
NextToken (string) --
A token to resume pagination.
AppRegistry.Paginator.ListAssociatedResources¶paginator = client.get_paginator('list_associated_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppRegistry.Client.list_associated_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
application='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or ID of the application.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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) --
A token to resume pagination.
AppRegistry.Paginator.ListAttributeGroups¶paginator = client.get_paginator('list_attribute_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppRegistry.Client.list_attribute_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'attributeGroups': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
This list of attribute groups.
Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.
The globally unique attribute group identifier of the attribute group.
The Amazon resource name (ARN) that specifies the attribute group across services.
The name of the attribute group.
The description of the attribute group that the user provides.
The ISO-8601 formatted timestamp of the moment the attribute group was created.
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
A token to resume pagination.
AppRegistry.Paginator.ListAttributeGroupsForApplication¶paginator = client.get_paginator('list_attribute_groups_for_application')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AppRegistry.Client.list_attribute_groups_for_application().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
application='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name or ID of the application.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'attributeGroupsDetails': [
{
'id': 'string',
'arn': 'string',
'name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
attributeGroupsDetails (list) --
The details related to a specific attribute group.
(dict) --
The details related to a specific AttributeGroup.
id (string) --
The unique identifier of the attribute group.
arn (string) --
The Amazon resource name (ARN) that specifies the attribute group.
name (string) --
Warning
This field is no longer supported. We recommend you don't use the field when using ListAttributeGroupsForApplication .
The name of the attribute group.
NextToken (string) --
A token to resume pagination.