amazonka-servicecatalog-appregistry-2.0: Amazon Service Catalog App Registry SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ServiceCatalogAppRegistry.Lens

Description

 
Synopsis

Operations

AssociateAttributeGroup

associateAttributeGroup_attributeGroup :: Lens' AssociateAttributeGroup Text Source #

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

associateAttributeGroupResponse_applicationArn :: Lens' AssociateAttributeGroupResponse (Maybe Text) Source #

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

associateAttributeGroupResponse_attributeGroupArn :: Lens' AssociateAttributeGroupResponse (Maybe Text) Source #

The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.

AssociateResource

associateResource_application :: Lens' AssociateResource Text Source #

The name or ID of the application.

associateResource_resourceType :: Lens' AssociateResource ResourceType Source #

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

associateResource_resource :: Lens' AssociateResource Text Source #

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

associateResourceResponse_applicationArn :: Lens' AssociateResourceResponse (Maybe Text) Source #

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

associateResourceResponse_resourceArn :: Lens' AssociateResourceResponse (Maybe Text) Source #

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

CreateApplication

createApplication_description :: Lens' CreateApplication (Maybe Text) Source #

The description of the application.

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #

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

createApplication_name :: Lens' CreateApplication Text Source #

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

createApplication_clientToken :: Lens' CreateApplication Text Source #

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.

CreateAttributeGroup

createAttributeGroup_description :: Lens' CreateAttributeGroup (Maybe Text) Source #

The description of the attribute group that the user provides.

createAttributeGroup_tags :: Lens' CreateAttributeGroup (Maybe (HashMap Text Text)) Source #

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

createAttributeGroup_attributes :: Lens' CreateAttributeGroup Text Source #

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.

createAttributeGroup_clientToken :: Lens' CreateAttributeGroup Text Source #

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.

DeleteApplication

deleteApplication_application :: Lens' DeleteApplication Text Source #

The name or ID of the application.

DeleteAttributeGroup

deleteAttributeGroup_attributeGroup :: Lens' DeleteAttributeGroup Text Source #

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

DisassociateAttributeGroup

disassociateAttributeGroup_attributeGroup :: Lens' DisassociateAttributeGroup Text Source #

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

disassociateAttributeGroupResponse_applicationArn :: Lens' DisassociateAttributeGroupResponse (Maybe Text) Source #

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

disassociateAttributeGroupResponse_attributeGroupArn :: Lens' DisassociateAttributeGroupResponse (Maybe Text) Source #

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

DisassociateResource

disassociateResource_resourceType :: Lens' DisassociateResource ResourceType Source #

The type of the resource that is being disassociated.

disassociateResourceResponse_applicationArn :: Lens' DisassociateResourceResponse (Maybe Text) Source #

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

disassociateResourceResponse_resourceArn :: Lens' DisassociateResourceResponse (Maybe Text) Source #

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

GetApplication

getApplication_application :: Lens' GetApplication Text Source #

The name or ID of the application.

getApplicationResponse_arn :: Lens' GetApplicationResponse (Maybe Text) Source #

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

getApplicationResponse_associatedResourceCount :: Lens' GetApplicationResponse (Maybe Natural) Source #

The number of top-level resources that were registered as part of this application.

getApplicationResponse_creationTime :: Lens' GetApplicationResponse (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was created.

getApplicationResponse_integrations :: Lens' GetApplicationResponse (Maybe Integrations) Source #

The information about the integration of the application with other services, such as Resource Groups.

getApplicationResponse_lastUpdateTime :: Lens' GetApplicationResponse (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was last updated.

getApplicationResponse_name :: Lens' GetApplicationResponse (Maybe Text) Source #

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

getApplicationResponse_tags :: Lens' GetApplicationResponse (Maybe (HashMap Text Text)) Source #

Key-value pairs associated with the application.

GetAssociatedResource

getAssociatedResource_resourceType :: Lens' GetAssociatedResource ResourceType Source #

The type of resource associated with the application.

getAssociatedResource_resource :: Lens' GetAssociatedResource Text Source #

The name or ID of the resource associated with the application.

GetAttributeGroup

getAttributeGroup_attributeGroup :: Lens' GetAttributeGroup Text Source #

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

getAttributeGroupResponse_arn :: Lens' GetAttributeGroupResponse (Maybe Text) Source #

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

getAttributeGroupResponse_attributes :: Lens' GetAttributeGroupResponse (Maybe Text) Source #

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.

getAttributeGroupResponse_creationTime :: Lens' GetAttributeGroupResponse (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment the attribute group was created.

getAttributeGroupResponse_description :: Lens' GetAttributeGroupResponse (Maybe Text) Source #

The description of the attribute group that the user provides.

getAttributeGroupResponse_lastUpdateTime :: Lens' GetAttributeGroupResponse (Maybe UTCTime) Source #

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.

getAttributeGroupResponse_tags :: Lens' GetAttributeGroupResponse (Maybe (HashMap Text Text)) Source #

Key-value pairs associated with the attribute group.

GetConfiguration

ListApplications

listApplications_maxResults :: Lens' ListApplications (Maybe Natural) Source #

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.

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

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

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

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

ListAssociatedAttributeGroups

listAssociatedAttributeGroups_maxResults :: Lens' ListAssociatedAttributeGroups (Maybe Natural) Source #

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.

listAssociatedAttributeGroups_nextToken :: Lens' ListAssociatedAttributeGroups (Maybe Text) Source #

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

listAssociatedAttributeGroupsResponse_nextToken :: Lens' ListAssociatedAttributeGroupsResponse (Maybe Text) Source #

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

ListAssociatedResources

listAssociatedResources_maxResults :: Lens' ListAssociatedResources (Maybe Natural) Source #

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.

listAssociatedResources_nextToken :: Lens' ListAssociatedResources (Maybe Text) Source #

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

listAssociatedResourcesResponse_nextToken :: Lens' ListAssociatedResourcesResponse (Maybe Text) Source #

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

ListAttributeGroups

listAttributeGroups_maxResults :: Lens' ListAttributeGroups (Maybe Natural) Source #

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.

listAttributeGroups_nextToken :: Lens' ListAttributeGroups (Maybe Text) Source #

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

listAttributeGroupsResponse_nextToken :: Lens' ListAttributeGroupsResponse (Maybe Text) Source #

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

ListAttributeGroupsForApplication

listAttributeGroupsForApplication_maxResults :: Lens' ListAttributeGroupsForApplication (Maybe Natural) Source #

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.

listAttributeGroupsForApplication_nextToken :: Lens' ListAttributeGroupsForApplication (Maybe Text) Source #

This token retrieves the next page of results after a previous API call.

listAttributeGroupsForApplicationResponse_nextToken :: Lens' ListAttributeGroupsForApplicationResponse (Maybe Text) Source #

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

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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

PutConfiguration

putConfiguration_configuration :: Lens' PutConfiguration AppRegistryConfiguration Source #

Associates a TagKey configuration to an account.

SyncResource

syncResource_resourceType :: Lens' SyncResource ResourceType Source #

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

syncResource_resource :: Lens' SyncResource Text Source #

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.

syncResourceResponse_actionTaken :: Lens' SyncResourceResponse (Maybe SyncAction) Source #

The results of the output if an application is associated with an ARN value, which could be syncStarted or None.

syncResourceResponse_applicationArn :: Lens' SyncResourceResponse (Maybe Text) Source #

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

syncResourceResponse_resourceArn :: Lens' SyncResourceResponse (Maybe Text) Source #

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

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The new or modified tags for the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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

UpdateApplication

updateApplication_description :: Lens' UpdateApplication (Maybe Text) Source #

The new description of the application.

updateApplication_name :: Lens' UpdateApplication (Maybe Text) Source #

Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.

updateApplication_application :: Lens' UpdateApplication Text Source #

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

UpdateAttributeGroup

updateAttributeGroup_attributes :: Lens' UpdateAttributeGroup (Maybe Text) Source #

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.

updateAttributeGroup_description :: Lens' UpdateAttributeGroup (Maybe Text) Source #

The description of the attribute group that the user provides.

updateAttributeGroup_name :: Lens' UpdateAttributeGroup (Maybe Text) Source #

Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates.

updateAttributeGroup_attributeGroup :: Lens' UpdateAttributeGroup Text Source #

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

Types

AppRegistryConfiguration

Application

application_arn :: Lens' Application (Maybe Text) Source #

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

application_creationTime :: Lens' Application (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was created.

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

application_id :: Lens' Application (Maybe Text) Source #

The identifier of the application.

application_lastUpdateTime :: Lens' Application (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was last updated.

application_name :: Lens' Application (Maybe Text) Source #

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

application_tags :: Lens' Application (Maybe (HashMap Text Text)) Source #

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

ApplicationSummary

applicationSummary_arn :: Lens' ApplicationSummary (Maybe Text) Source #

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

applicationSummary_creationTime :: Lens' ApplicationSummary (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was created.

applicationSummary_description :: Lens' ApplicationSummary (Maybe Text) Source #

The description of the application.

applicationSummary_id :: Lens' ApplicationSummary (Maybe Text) Source #

The identifier of the application.

applicationSummary_lastUpdateTime :: Lens' ApplicationSummary (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment when the application was last updated.

applicationSummary_name :: Lens' ApplicationSummary (Maybe Text) Source #

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

AttributeGroup

attributeGroup_arn :: Lens' AttributeGroup (Maybe Text) Source #

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

attributeGroup_creationTime :: Lens' AttributeGroup (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment the attribute group was created.

attributeGroup_description :: Lens' AttributeGroup (Maybe Text) Source #

The description of the attribute group that the user provides.

attributeGroup_id :: Lens' AttributeGroup (Maybe Text) Source #

The globally unique attribute group identifier of the attribute group.

attributeGroup_lastUpdateTime :: Lens' AttributeGroup (Maybe UTCTime) Source #

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.

attributeGroup_name :: Lens' AttributeGroup (Maybe Text) Source #

The name of the attribute group.

attributeGroup_tags :: Lens' AttributeGroup (Maybe (HashMap Text Text)) Source #

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

AttributeGroupDetails

attributeGroupDetails_arn :: Lens' AttributeGroupDetails (Maybe Text) Source #

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

attributeGroupDetails_id :: Lens' AttributeGroupDetails (Maybe Text) Source #

The unique identifier of the attribute group.

attributeGroupDetails_name :: Lens' AttributeGroupDetails (Maybe Text) Source #

This field is no longer supported. We recommend you don't use the field when using ListAttributeGroupsForApplication.

The name of the attribute group.

AttributeGroupSummary

attributeGroupSummary_arn :: Lens' AttributeGroupSummary (Maybe Text) Source #

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

attributeGroupSummary_creationTime :: Lens' AttributeGroupSummary (Maybe UTCTime) Source #

The ISO-8601 formatted timestamp of the moment the attribute group was created.

attributeGroupSummary_description :: Lens' AttributeGroupSummary (Maybe Text) Source #

The description of the attribute group that the user provides.

attributeGroupSummary_id :: Lens' AttributeGroupSummary (Maybe Text) Source #

The globally unique attribute group identifier of the attribute group.

attributeGroupSummary_lastUpdateTime :: Lens' AttributeGroupSummary (Maybe UTCTime) Source #

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.

Integrations

integrations_resourceGroup :: Lens' Integrations (Maybe ResourceGroup) Source #

The information about the resource group integration.

Resource

resource_arn :: Lens' Resource (Maybe Text) Source #

The Amazon resource name (ARN) of the resource.

resource_associationTime :: Lens' Resource (Maybe UTCTime) Source #

The time the resource was associated with the application.

resource_integrations :: Lens' Resource (Maybe ResourceIntegrations) Source #

The service integration information about the resource.

resource_name :: Lens' Resource (Maybe Text) Source #

The name of the resource.

ResourceDetails

ResourceGroup

resourceGroup_arn :: Lens' ResourceGroup (Maybe Text) Source #

The Amazon resource name (ARN) of the resource group.

resourceGroup_errorMessage :: Lens' ResourceGroup (Maybe Text) Source #

The error message that generates when the propagation process for the resource group fails.

resourceGroup_state :: Lens' ResourceGroup (Maybe ResourceGroupState) Source #

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.

ResourceInfo

resourceInfo_arn :: Lens' ResourceInfo (Maybe Text) Source #

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

resourceInfo_name :: Lens' ResourceInfo (Maybe Text) Source #

The name of the resource.

resourceInfo_resourceType :: Lens' ResourceInfo (Maybe ResourceType) Source #

Provides information about the Service Catalog App Registry resource type.

ResourceIntegrations

resourceIntegrations_resourceGroup :: Lens' ResourceIntegrations (Maybe ResourceGroup) Source #

The information about the integration of Resource Groups.

TagQueryConfiguration

tagQueryConfiguration_tagKey :: Lens' TagQueryConfiguration (Maybe Text) Source #

Condition in the IAM policy that associates resources to an application.