AWS Service Catalog App Registry

2023/03/27 - AWS Service Catalog App Registry - 4 updated api methods

Changes  In this release, we started supporting ARN in applicationSpecifier and attributeGroupSpecifier. GetAttributeGroup, ListAttributeGroups and ListAttributeGroupsForApplication APIs will now have CreatedBy field in the response.

DeleteAttributeGroup (updated) Link ¶
Changes (response)
{'attributeGroup': {'createdBy': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

string

param attributeGroup

[REQUIRED]

The name, ID, or ARN 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),
        'createdBy': 'string'
    }
}

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.

      • createdBy (string) --

        The service principal that created the attribute group.

GetAttributeGroup (updated) Link ¶
Changes (response)
{'createdBy': 'string'}

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

See also: AWS API Documentation

Request Syntax

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

string

param attributeGroup

[REQUIRED]

The name, ID, or ARN 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'
    },
    'createdBy': '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) --

    • createdBy (string) --

      The service principal that created the attribute group.

ListAttributeGroups (updated) Link ¶
Changes (response)
{'attributeGroups': {'createdBy': 'string'}}

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

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

ListAttributeGroupsForApplication (updated) Link ¶
Changes (response)
{'attributeGroupsDetails': {'createdBy': 'string'}}

Lists the details of all attribute groups associated with a specific application. The results display in pages.

See also: AWS API Documentation

Request Syntax

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

string

param application

[REQUIRED]

The name or ID of the application.

type nextToken

string

param nextToken

This token retrieves 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. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.

rtype

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.