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.

client = session.create_client('servicecatalog-appregistry')

These are the available methods:

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'
)
Parameters
  • application (string) --

    [REQUIRED]

    The name or ID of the application.

  • attributeGroup (string) --

    [REQUIRED]

    The name or ID of the attribute group that holds the attributes to describe the application.

Return type

dict

Returns

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

associate_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='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The name or ID of the application.

  • resourceType (string) --

    [REQUIRED]

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

  • resource (string) --

    [REQUIRED]

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

Return type

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.

Exceptions

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.
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'
)
Parameters
  • name (string) --

    [REQUIRED]

    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.
  • tags (dict) --

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

    • (string) --
      • (string) --
  • clientToken (string) --

    [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.

Return type

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

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) --

Exceptions

create_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'
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the attribute group.

  • description (string) -- The description of the attribute group that the user provides.
  • attributes (string) --

    [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.

  • tags (dict) --

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

    • (string) --
      • (string) --
  • clientToken (string) --

    [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.

Return type

dict

Returns

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.

        • (string) --
          • (string) --

Exceptions

delete_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'
)
Parameters
application (string) --

[REQUIRED]

The name or ID of the application.

Return type
dict
Returns
Response Syntax
{
    'application': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • application (dict) --

      Information about the deleted 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.

Exceptions

delete_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'
)
Parameters
attributeGroup (string) --

[REQUIRED]

The name or ID of the attribute group that holds the attributes to describe the application.

Return type
dict
Returns
Response Syntax
{
    'attributeGroup': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • attributeGroup (dict) --

      Information about the deleted 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.

Exceptions

disassociate_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'
)
Parameters
  • application (string) --

    [REQUIRED]

    The name or ID of the application.

  • attributeGroup (string) --

    [REQUIRED]

    The name or ID of the attribute group that holds the attributes to describe the application.

Return type

dict

Returns

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

disassociate_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='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The name or ID of the application.

  • resourceType (string) --

    [REQUIRED]

    The type of the resource that is being disassociated.

  • resource (string) --

    [REQUIRED]

    The name or ID of the resource.

Return type

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.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_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'
)
Parameters
application (string) --

[REQUIRED]

The name or ID of the application.

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

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.

Exceptions

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='string'
)
Parameters
  • application (string) --

    [REQUIRED]

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

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

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.

Exceptions

get_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'
)
Parameters
attributeGroup (string) --

[REQUIRED]

The name or ID of the attribute group that holds the attributes to describe the application.

Return type
dict
Returns
Response Syntax
{
    '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

  • (dict) --
    • id (string) --

      The 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.

    • attributes (string) --

      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.

    • 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 associated with the attribute group.

      • (string) --
        • (string) --

Exceptions

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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

list_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
)
Parameters
  • application (string) --

    [REQUIRED]

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

{
    'attributeGroups': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • attributeGroups (list) --

      A list of attribute group IDs.

      • (string) --
    • nextToken (string) --

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

Exceptions

list_associated_resources(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_associated_resources(
    application='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • application (string) --

    [REQUIRED]

    The name or ID 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'
        },
    ],
    '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.

    • nextToken (string) --

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

Exceptions

list_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
)
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

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

list_tags_for_resource(**kwargs)

Lists all of the tags on the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The Amazon resource name (ARN) that specifies the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The tags on the resource.

      • (string) --
        • (string) --

Exceptions

sync_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='string'
)
Parameters
  • resourceType (string) --

    [REQUIRED]

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

  • resource (string) --

    [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.

Return type

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.

Exceptions

tag_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'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon resource name (ARN) that specifies the resource.

  • tags (dict) --

    [REQUIRED]

    The new or modified tags for the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_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',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon resource name (ARN) that specifies the resource.

  • tagKeys (list) --

    [REQUIRED]

    A list of the tag keys to remove from the specified resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_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'
)
Parameters
  • application (string) --

    [REQUIRED]

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

  • name (string) -- The new name of the application. The name must be unique in the region in which you are updating the application.
  • description (string) -- The new description of the application.
Return type

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

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) --

Exceptions

update_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'
)
Parameters
  • attributeGroup (string) --

    [REQUIRED]

    The name or ID of the attribute group that holds the attributes to describe the application.

  • name (string) -- The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.
  • description (string) -- The description of the attribute group that the user provides.
  • attributes (string) -- 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.
Return type

dict

Returns

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.

        • (string) --
          • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class AppRegistry.Client.exceptions.ConflictException

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AppRegistry.Client.exceptions.InternalServerException

The service is experiencing internal problems.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service is experiencing internal problems.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AppRegistry.Client.exceptions.ResourceNotFoundException

The specified resource does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource does not exist.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AppRegistry.Client.exceptions.ServiceQuotaExceededException

The maximum number of resources per account has been reached.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The maximum number of resources per account has been reached.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class AppRegistry.Client.exceptions.ValidationException

The request has invalid or missing parameters.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request has invalid or missing parameters.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

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.

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.

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

{
    'resources': [
        {
            'name': 'string',
            'arn': '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.

    • NextToken (string) --

      A token to resume pagination.

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)
        },
    ],
    '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) --

      A token to resume pagination.