AppRegistry *********** Client ====== class 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 Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications * ListAssociatedAttributeGroups * ListAssociatedResources * ListAttributeGroups * ListAttributeGroupsForApplication AppRegistry / Paginator / ListAttributeGroups ListAttributeGroups ******************* class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'attributeGroups': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'description': 'string', 'creationTime': datetime(2015, 1, 1), 'lastUpdateTime': datetime(2015, 1, 1), 'createdBy': 'string' }, ], '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. * **createdBy** *(string) --* The service principal that created the attribute group. * **NextToken** *(string) --* A token to resume pagination. AppRegistry / Paginator / ListAssociatedAttributeGroups ListAssociatedAttributeGroups ***************************** class 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' } ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name or ID of the application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'attributeGroups': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **attributeGroups** *(list) --* A list of attribute group IDs. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. AppRegistry / Paginator / ListAssociatedResources ListAssociatedResources *********************** class 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' } ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name, ID, or ARN of the application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: 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) --* A token to resume pagination. AppRegistry / Paginator / ListAttributeGroupsForApplication ListAttributeGroupsForApplication ********************************* class 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' } ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name or ID of the application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'attributeGroupsDetails': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'createdBy': '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. * **createdBy** *(string) --* The service principal that created the attribute group. * **NextToken** *(string) --* A token to resume pagination. AppRegistry / Paginator / ListApplications ListApplications **************** class AppRegistry.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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. AppRegistry / Client / list_applications list_applications ***************** AppRegistry.Client.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 ) Parameters: * **nextToken** (*string*) -- The token to use to get the next page of results after a previous API call. * **maxResults** (*integer*) -- 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. Return type: dict Returns: **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.ValidationException" * "AppRegistry.Client.exceptions.InternalServerException" AppRegistry / Client / get_paginator get_paginator ************* AppRegistry.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AppRegistry / Client / list_associated_resources list_associated_resources ************************* AppRegistry.Client.list_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 ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name, ID, or ARN of the application. * **nextToken** (*string*) -- The token to use to get the next page of results after a previous API call. * **maxResults** (*integer*) -- 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. Return type: 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. **Exceptions** * "AppRegistry.Client.exceptions.ResourceNotFoundException" * "AppRegistry.Client.exceptions.ValidationException" * "AppRegistry.Client.exceptions.InternalServerException" AppRegistry / Client / list_attribute_groups_for_application list_attribute_groups_for_application ************************************* AppRegistry.Client.list_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 ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name or ID of the application. * **nextToken** (*string*) -- This token retrieves the next page of results after a previous API call. * **maxResults** (*integer*) -- The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional. Return type: dict Returns: **Response Syntax** { 'attributeGroupsDetails': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'createdBy': '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. * **createdBy** *(string) --* The service principal that created 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.ResourceNotFoundException" * "AppRegistry.Client.exceptions.ValidationException" * "AppRegistry.Client.exceptions.InternalServerException" AppRegistry / Client / can_paginate can_paginate ************ AppRegistry.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. AppRegistry / Client / get_associated_resource get_associated_resource *********************** AppRegistry.Client.get_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', nextToken='string', resourceTagStatus=[ 'SUCCESS'|'FAILED'|'IN_PROGRESS'|'SKIPPED', ], maxResults=123 ) Parameters: * **application** (*string*) -- **[REQUIRED]** The name, ID, or ARN of the application. * **resourceType** (*string*) -- **[REQUIRED]** The type of resource associated with the application. * **resource** (*string*) -- **[REQUIRED]** The name or ID of the resource associated with the application. * **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. * **resourceTagStatus** (*list*) -- States whether an application tag is applied, not applied, in the process of being applied, or skipped. * *(string) --* * **maxResults** (*integer*) -- The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional. Return type: 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: >>``<>``<>``<>``<>``<>``<