libZSservicesZSamazonka-servicecatalog-appregistryZSamazonka-servicecatalog-appregistry
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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.

ListAttributeGroups

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

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

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.

listAttributeGroupsResponse_nextToken :: Lens' ListAttributeGroupsResponse (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.

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_applicationArn :: Lens' SyncResourceResponse (Maybe Text) Source #

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

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_resourceArn :: Lens' SyncResourceResponse (Maybe Text) Source #

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

DeleteApplication

deleteApplication_application :: Lens' DeleteApplication Text Source #

The name or ID of the application.

UpdateApplication

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

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

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

The new description of the application.

updateApplication_application :: Lens' UpdateApplication Text Source #

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

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.

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.

GetApplication

getApplication_application :: Lens' GetApplication Text Source #

The name or ID of the application.

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

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

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

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

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

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

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

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

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_lastUpdateTime :: Lens' GetApplicationResponse (Maybe UTCTime) Source #

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

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.

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.

DeleteAttributeGroup

deleteAttributeGroup_attributeGroup :: Lens' DeleteAttributeGroup Text Source #

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

UpdateAttributeGroup

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

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

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_attributeGroup :: Lens' UpdateAttributeGroup Text Source #

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

ListAssociatedAttributeGroups

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

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

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.

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

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

GetAttributeGroup

getAttributeGroup_attributeGroup :: Lens' GetAttributeGroup Text Source #

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

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

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

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_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_description :: Lens' GetAttributeGroupResponse (Maybe Text) Source #

The description of the attribute group that the user provides.

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

Key-value pairs associated with 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.

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.

ListAssociatedResources

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

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

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.

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

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

ListApplications

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

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

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.

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

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

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.

Types

Application

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

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

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

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

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_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_description :: Lens' Application (Maybe Text) Source #

The description of the application.

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

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

ApplicationSummary

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

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

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

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

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.

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_description :: Lens' ApplicationSummary (Maybe Text) Source #

The description of the application.

AttributeGroup

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

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

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

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

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

The name of the attribute group.

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_description :: Lens' AttributeGroup (Maybe Text) Source #

The description of the attribute group that the user provides.

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

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

AttributeGroupSummary

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

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

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

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

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.

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

The description of the attribute group that the user provides.

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_integrations :: Lens' Resource (Maybe ResourceIntegrations) Source #

The service integration information about the resource.

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

The time the resource was associated with the application.

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

The name of the resource.

ResourceGroup

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.

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.

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.

ResourceIntegrations

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

The information about the integration of Resource Groups.