AWS Service Catalog App Registry

2020/11/12 - AWS Service Catalog App Registry - 16 new api methods

Changes  Update servicecatalog-appregistry client to latest version

CreateApplication (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param name:

[REQUIRED]

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

type description:

string

param description:

The description of the application.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

[REQUIRED]

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the clientToken, the same response is returned for each repeated request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • application (dict) --

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

GetAttributeGroup (new) Link ¶

Retrieves an attribute group, either by its name or its ID.

See also: AWS API Documentation

Request Syntax

client.get_attribute_group(
    attributeGroup='string'
)
type attributeGroup:

string

param attributeGroup:

[REQUIRED]

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

rtype:

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

    • arn (string) --

      The Amazon resource name (ARN) that specifies the application 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 you can use to associate with the attribute group.

      • (string) --

        • (string) --

ListAssociatedAttributeGroups (new) Link ¶

Lists all attribute groups that are associated with specified application. Results are paginated.

See also: AWS API Documentation

Request Syntax

client.list_associated_attribute_groups(
    application='string',
    nextToken='string',
    maxResults=123
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

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

UpdateApplication (new) Link ¶

Updates an existing application with new attributes.

See also: AWS API Documentation

Request Syntax

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

string

param application:

[REQUIRED]

The name or ID of the application. The name must be unique in the region in which you are updating the attribute group.

type name:

string

param name:

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

type description:

string

param description:

The description of the application.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • application (dict) --

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

GetApplication (new) Link ¶

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

client.get_application(
    application='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

rtype:

dict

returns:

Response Syntax

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

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 you can use to associate with the application.

      • (string) --

        • (string) --

ListAttributeGroups (new) Link ¶

Lists all attribute groups which you have access to. Results are paginated.

See also: AWS API Documentation

Request Syntax

client.list_attribute_groups(
    nextToken='string',
    maxResults=123
)
type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

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

      A list of attribute group IDs.

      • (dict) --

        Summary of a 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 application 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.

AssociateResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.associate_resource(
    application='string',
    resourceType='CFN_STACK',
    resource='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type resourceType:

string

param resourceType:

[REQUIRED]

type resource:

string

param resource:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • applicationArn (string) --

      The Amazon resource name (ARN) of the application that was augmented with attributes.

    • resourceArn (string) --

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

DeleteAttributeGroup (new) Link ¶

Deletes an attribute group, specified either by its attribute group ID or name.

See also: AWS API Documentation

Request Syntax

client.delete_attribute_group(
    attributeGroup='string'
)
type attributeGroup:

string

param attributeGroup:

[REQUIRED]

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

rtype:

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

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

      • id (string) --

        The globally unique attribute group identifier of the attribute group.

      • arn (string) --

        The Amazon resource name (ARN) that specifies the application 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.

DeleteApplication (new) Link ¶

Delete an application, specified either by its application ID or name.

See also: AWS API Documentation

Request Syntax

client.delete_application(
    application='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • application (dict) --

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

ListApplications (new) Link ¶

Retrieves a list of all of your applications. Results are paginated.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    nextToken='string',
    maxResults=123
)
type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

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

      The name or ID of the application.

      • (dict) --

        Summary of a 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.

AssociateAttributeGroup (new) Link ¶

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This way applications can be described with user-defined details which are machine-readable (e.g. for third-party integrations).

See also: AWS API Documentation

Request Syntax

client.associate_attribute_group(
    application='string',
    attributeGroup='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type attributeGroup:

string

param attributeGroup:

[REQUIRED]

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

rtype:

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.

CreateAttributeGroup (new) Link ¶

Creates a new attribute group as a container for user-defined attributes. This approach 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

client.create_attribute_group(
    name='string',
    description='string',
    attributes='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
type name:

string

param name:

[REQUIRED]

The name of the attribute group.

type description:

string

param description:

The description of the attribute group that the user provides.

type attributes:

string

param attributes:

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

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

[REQUIRED]

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the clientToken, the same response is returned for each repeated request.

This field is autopopulated if not provided.

rtype:

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 name or ID of the attribute group that holds the attributes to describe the application.

      • id (string) --

        The globally unique attribute group identifier of the attribute group.

      • arn (string) --

        The Amazon resource name (ARN) that specifies the application 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) --

ListAssociatedResources (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param application:

[REQUIRED]

The name or ID of the application.

type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

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

rtype:

dict

returns:

Response Syntax

{
    'resources': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • resources (list) --

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

      • (dict) --

        Information about the resource.

        • name (string) --

          The name of the resource.

        • arn (string) --

          The Amazon resource name (ARN) that specifies the application across services.

    • nextToken (string) --

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

UpdateAttributeGroup (new) Link ¶

Updates an existing attribute group with new details.

See also: AWS API Documentation

Request Syntax

client.update_attribute_group(
    attributeGroup='string',
    name='string',
    description='string',
    attributes='string'
)
type attributeGroup:

string

param attributeGroup:

[REQUIRED]

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

type name:

string

param name:

The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.

type description:

string

param description:

The description of the attribute group that the user provides.

type attributes:

string

param attributes:

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.

rtype:

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 name or ID of the attribute group that holds the attributes to describe the application.

      • id (string) --

        The globally unique attribute group identifier of the attribute group.

      • arn (string) --

        The Amazon resource name (ARN) that specifies the application 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) --

DisassociateResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.disassociate_resource(
    application='string',
    resourceType='CFN_STACK',
    resource='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type resourceType:

string

param resourceType:

[REQUIRED]

The type of the resource that's being disassociated.

type resource:

string

param resource:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • applicationArn (string) --

      The Amazon resource name (ARN) of the application that was augmented with attributes.

    • resourceArn (string) --

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

DisassociateAttributeGroup (new) Link ¶

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

client.disassociate_attribute_group(
    application='string',
    attributeGroup='string'
)
type application:

string

param application:

[REQUIRED]

The name or ID of the application.

type attributeGroup:

string

param attributeGroup:

[REQUIRED]

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

rtype:

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.