Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- DeleteConstraint
- UpdateConstraint
- CreateProvisionedProductPlan
- CreateProduct
- DescribeCopyProductStatus
- TerminateProvisionedProduct
- UpdateProvisionedProduct
- DescribeProvisioningArtifact
- ListRecordHistory
- DescribeProvisionedProductPlan
- AssociateTagOptionWithResource
- CreateTagOption
- DisassociateProductFromPortfolio
- ListConstraintsForPortfolio (Paginated)
- DescribeRecord
- DescribeConstraint
- CreateProvisioningArtifact
- ListPortfolios (Paginated)
- DescribeProductView
- CreatePortfolioShare
- ListProvisioningArtifacts
- SearchProducts
- SearchProvisionedProducts
- DescribeProduct
- DeleteProvisionedProductPlan
- CreateConstraint
- ListProvisionedProductPlans
- ListPortfolioAccess
- DisassociatePrincipalFromPortfolio
- DescribeTagOption
- DisassociateTagOptionFromResource
- DescribePortfolio
- AssociateProductWithPortfolio
- ListAcceptedPortfolioShares (Paginated)
- ExecuteProvisionedProductPlan
- AcceptPortfolioShare
- ScanProvisionedProducts
- ListPrincipalsForPortfolio (Paginated)
- DeleteProduct
- UpdateProduct
- ProvisionProduct
- RejectPortfolioShare
- DeleteTagOption
- UpdateTagOption
- ListTagOptions (Paginated)
- SearchProductsAsAdmin (Paginated)
- DeletePortfolio
- UpdatePortfolio
- ListPortfoliosForProduct (Paginated)
- DescribeProductAsAdmin
- DescribeProvisioningParameters
- AssociatePrincipalWithPortfolio
- DescribeProvisionedProduct
- CopyProduct
- UpdateProvisioningArtifact
- DeletePortfolioShare
- DeleteProvisioningArtifact
- CreatePortfolio
- ListLaunchPaths (Paginated)
- ListResourcesForTagOption (Paginated)
- Types
- AccessLevelFilterKey
- ChangeAction
- CopyOption
- CopyProductStatus
- EvaluationType
- PrincipalType
- ProductSource
- ProductType
- ProductViewFilterBy
- ProductViewSortBy
- ProvisionedProductPlanStatus
- ProvisionedProductPlanType
- ProvisionedProductStatus
- ProvisionedProductViewFilterBy
- ProvisioningArtifactPropertyName
- ProvisioningArtifactType
- RecordStatus
- Replacement
- RequestStatus
- RequiresRecreation
- ResourceAttribute
- SortOrder
- AccessLevelFilter
- CloudWatchDashboard
- ConstraintDetail
- ConstraintSummary
- LaunchPathSummary
- ListRecordHistorySearchFilter
- ListTagOptionsFilters
- ParameterConstraints
- PortfolioDetail
- Principal
- ProductViewAggregationValue
- ProductViewDetail
- ProductViewSummary
- ProvisionedProductAttribute
- ProvisionedProductDetail
- ProvisionedProductPlanDetails
- ProvisionedProductPlanSummary
- ProvisioningArtifact
- ProvisioningArtifactDetail
- ProvisioningArtifactParameter
- ProvisioningArtifactProperties
- ProvisioningArtifactSummary
- ProvisioningParameter
- RecordDetail
- RecordError
- RecordOutput
- RecordTag
- ResourceChange
- ResourceChangeDetail
- ResourceDetail
- ResourceTargetDefinition
- Tag
- TagOptionDetail
- TagOptionSummary
- UpdateProvisioningParameter
- UsageInstruction
AWS Service Catalog
AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for use on AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in AWS Service Catalog Concepts .
- serviceCatalog :: Service
- _InvalidParametersException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagOptionNotMigratedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.ServiceCatalog.DeleteConstraint
- module Network.AWS.ServiceCatalog.UpdateConstraint
- module Network.AWS.ServiceCatalog.CreateProvisionedProductPlan
- module Network.AWS.ServiceCatalog.CreateProduct
- module Network.AWS.ServiceCatalog.DescribeCopyProductStatus
- module Network.AWS.ServiceCatalog.TerminateProvisionedProduct
- module Network.AWS.ServiceCatalog.UpdateProvisionedProduct
- module Network.AWS.ServiceCatalog.DescribeProvisioningArtifact
- module Network.AWS.ServiceCatalog.ListRecordHistory
- module Network.AWS.ServiceCatalog.DescribeProvisionedProductPlan
- module Network.AWS.ServiceCatalog.AssociateTagOptionWithResource
- module Network.AWS.ServiceCatalog.CreateTagOption
- module Network.AWS.ServiceCatalog.DisassociateProductFromPortfolio
- module Network.AWS.ServiceCatalog.ListConstraintsForPortfolio
- module Network.AWS.ServiceCatalog.DescribeRecord
- module Network.AWS.ServiceCatalog.DescribeConstraint
- module Network.AWS.ServiceCatalog.CreateProvisioningArtifact
- module Network.AWS.ServiceCatalog.ListPortfolios
- module Network.AWS.ServiceCatalog.DescribeProductView
- module Network.AWS.ServiceCatalog.CreatePortfolioShare
- module Network.AWS.ServiceCatalog.ListProvisioningArtifacts
- module Network.AWS.ServiceCatalog.SearchProducts
- module Network.AWS.ServiceCatalog.SearchProvisionedProducts
- module Network.AWS.ServiceCatalog.DescribeProduct
- module Network.AWS.ServiceCatalog.DeleteProvisionedProductPlan
- module Network.AWS.ServiceCatalog.CreateConstraint
- module Network.AWS.ServiceCatalog.ListProvisionedProductPlans
- module Network.AWS.ServiceCatalog.ListPortfolioAccess
- module Network.AWS.ServiceCatalog.DisassociatePrincipalFromPortfolio
- module Network.AWS.ServiceCatalog.DescribeTagOption
- module Network.AWS.ServiceCatalog.DisassociateTagOptionFromResource
- module Network.AWS.ServiceCatalog.DescribePortfolio
- module Network.AWS.ServiceCatalog.AssociateProductWithPortfolio
- module Network.AWS.ServiceCatalog.ListAcceptedPortfolioShares
- module Network.AWS.ServiceCatalog.ExecuteProvisionedProductPlan
- module Network.AWS.ServiceCatalog.AcceptPortfolioShare
- module Network.AWS.ServiceCatalog.ScanProvisionedProducts
- module Network.AWS.ServiceCatalog.ListPrincipalsForPortfolio
- module Network.AWS.ServiceCatalog.DeleteProduct
- module Network.AWS.ServiceCatalog.UpdateProduct
- module Network.AWS.ServiceCatalog.ProvisionProduct
- module Network.AWS.ServiceCatalog.RejectPortfolioShare
- module Network.AWS.ServiceCatalog.DeleteTagOption
- module Network.AWS.ServiceCatalog.UpdateTagOption
- module Network.AWS.ServiceCatalog.ListTagOptions
- module Network.AWS.ServiceCatalog.SearchProductsAsAdmin
- module Network.AWS.ServiceCatalog.DeletePortfolio
- module Network.AWS.ServiceCatalog.UpdatePortfolio
- module Network.AWS.ServiceCatalog.ListPortfoliosForProduct
- module Network.AWS.ServiceCatalog.DescribeProductAsAdmin
- module Network.AWS.ServiceCatalog.DescribeProvisioningParameters
- module Network.AWS.ServiceCatalog.AssociatePrincipalWithPortfolio
- module Network.AWS.ServiceCatalog.DescribeProvisionedProduct
- module Network.AWS.ServiceCatalog.CopyProduct
- module Network.AWS.ServiceCatalog.UpdateProvisioningArtifact
- module Network.AWS.ServiceCatalog.DeletePortfolioShare
- module Network.AWS.ServiceCatalog.DeleteProvisioningArtifact
- module Network.AWS.ServiceCatalog.CreatePortfolio
- module Network.AWS.ServiceCatalog.ListLaunchPaths
- module Network.AWS.ServiceCatalog.ListResourcesForTagOption
- data AccessLevelFilterKey
- data ChangeAction
- data CopyOption = CopyTags
- data CopyProductStatus
- data EvaluationType
- data PrincipalType = IAM
- data ProductSource = PSAccount
- data ProductType
- data ProductViewFilterBy
- data ProductViewSortBy
- data ProvisionedProductPlanStatus
- data ProvisionedProductPlanType = Cloudformation
- data ProvisionedProductStatus
- data ProvisionedProductViewFilterBy = SearchQuery
- data ProvisioningArtifactPropertyName = Id
- data ProvisioningArtifactType
- data RecordStatus
- data Replacement
- = Conditional
- | False'
- | True'
- data RequestStatus
- data RequiresRecreation
- = Always
- | Conditionally
- | Never
- data ResourceAttribute
- data SortOrder
- data AccessLevelFilter
- accessLevelFilter :: AccessLevelFilter
- alfValue :: Lens' AccessLevelFilter (Maybe Text)
- alfKey :: Lens' AccessLevelFilter (Maybe AccessLevelFilterKey)
- data CloudWatchDashboard
- cloudWatchDashboard :: CloudWatchDashboard
- cwdName :: Lens' CloudWatchDashboard (Maybe Text)
- data ConstraintDetail
- constraintDetail :: ConstraintDetail
- cdConstraintId :: Lens' ConstraintDetail (Maybe Text)
- cdOwner :: Lens' ConstraintDetail (Maybe Text)
- cdType :: Lens' ConstraintDetail (Maybe Text)
- cdDescription :: Lens' ConstraintDetail (Maybe Text)
- data ConstraintSummary
- constraintSummary :: ConstraintSummary
- csType :: Lens' ConstraintSummary (Maybe Text)
- csDescription :: Lens' ConstraintSummary (Maybe Text)
- data LaunchPathSummary
- launchPathSummary :: LaunchPathSummary
- lpsConstraintSummaries :: Lens' LaunchPathSummary [ConstraintSummary]
- lpsName :: Lens' LaunchPathSummary (Maybe Text)
- lpsId :: Lens' LaunchPathSummary (Maybe Text)
- lpsTags :: Lens' LaunchPathSummary [Tag]
- data ListRecordHistorySearchFilter
- listRecordHistorySearchFilter :: ListRecordHistorySearchFilter
- lrhsfValue :: Lens' ListRecordHistorySearchFilter (Maybe Text)
- lrhsfKey :: Lens' ListRecordHistorySearchFilter (Maybe Text)
- data ListTagOptionsFilters
- listTagOptionsFilters :: ListTagOptionsFilters
- ltofValue :: Lens' ListTagOptionsFilters (Maybe Text)
- ltofActive :: Lens' ListTagOptionsFilters (Maybe Bool)
- ltofKey :: Lens' ListTagOptionsFilters (Maybe Text)
- data ParameterConstraints
- parameterConstraints :: ParameterConstraints
- pcAllowedValues :: Lens' ParameterConstraints [Text]
- data PortfolioDetail
- portfolioDetail :: PortfolioDetail
- pdARN :: Lens' PortfolioDetail (Maybe Text)
- pdCreatedTime :: Lens' PortfolioDetail (Maybe UTCTime)
- pdId :: Lens' PortfolioDetail (Maybe Text)
- pdDisplayName :: Lens' PortfolioDetail (Maybe Text)
- pdDescription :: Lens' PortfolioDetail (Maybe Text)
- pdProviderName :: Lens' PortfolioDetail (Maybe Text)
- data Principal
- principal :: Principal
- pPrincipalType :: Lens' Principal (Maybe PrincipalType)
- pPrincipalARN :: Lens' Principal (Maybe Text)
- data ProductViewAggregationValue
- productViewAggregationValue :: ProductViewAggregationValue
- pvavValue :: Lens' ProductViewAggregationValue (Maybe Text)
- pvavApproximateCount :: Lens' ProductViewAggregationValue (Maybe Int)
- data ProductViewDetail
- productViewDetail :: ProductViewDetail
- pvdStatus :: Lens' ProductViewDetail (Maybe RequestStatus)
- pvdProductViewSummary :: Lens' ProductViewDetail (Maybe ProductViewSummary)
- pvdCreatedTime :: Lens' ProductViewDetail (Maybe UTCTime)
- pvdProductARN :: Lens' ProductViewDetail (Maybe Text)
- data ProductViewSummary
- productViewSummary :: ProductViewSummary
- pvsOwner :: Lens' ProductViewSummary (Maybe Text)
- pvsSupportURL :: Lens' ProductViewSummary (Maybe Text)
- pvsShortDescription :: Lens' ProductViewSummary (Maybe Text)
- pvsHasDefaultPath :: Lens' ProductViewSummary (Maybe Bool)
- pvsDistributor :: Lens' ProductViewSummary (Maybe Text)
- pvsName :: Lens' ProductViewSummary (Maybe Text)
- pvsId :: Lens' ProductViewSummary (Maybe Text)
- pvsType :: Lens' ProductViewSummary (Maybe ProductType)
- pvsSupportEmail :: Lens' ProductViewSummary (Maybe Text)
- pvsProductId :: Lens' ProductViewSummary (Maybe Text)
- pvsSupportDescription :: Lens' ProductViewSummary (Maybe Text)
- data ProvisionedProductAttribute
- provisionedProductAttribute :: ProvisionedProductAttribute
- ppaIdempotencyToken :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaStatus :: Lens' ProvisionedProductAttribute (Maybe ProvisionedProductStatus)
- ppaProvisioningArtifactId :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaARN :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaCreatedTime :: Lens' ProvisionedProductAttribute (Maybe UTCTime)
- ppaUserARN :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaStatusMessage :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaName :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaLastRecordId :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaUserARNSession :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaId :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaType :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaPhysicalId :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaProductId :: Lens' ProvisionedProductAttribute (Maybe Text)
- ppaTags :: Lens' ProvisionedProductAttribute [Tag]
- data ProvisionedProductDetail
- provisionedProductDetail :: ProvisionedProductDetail
- ppdIdempotencyToken :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdStatus :: Lens' ProvisionedProductDetail (Maybe ProvisionedProductStatus)
- ppdARN :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdCreatedTime :: Lens' ProvisionedProductDetail (Maybe UTCTime)
- ppdStatusMessage :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdName :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdLastRecordId :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdId :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdType :: Lens' ProvisionedProductDetail (Maybe Text)
- data ProvisionedProductPlanDetails
- provisionedProductPlanDetails :: ProvisionedProductPlanDetails
- pppdStatus :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanStatus)
- pppdProvisionProductId :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdProvisioningArtifactId :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdProvisionProductName :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdCreatedTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime)
- pppdNotificationARNs :: Lens' ProvisionedProductPlanDetails [Text]
- pppdPlanId :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdPlanName :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdStatusMessage :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdUpdatedTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime)
- pppdPathId :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdProvisioningParameters :: Lens' ProvisionedProductPlanDetails [UpdateProvisioningParameter]
- pppdPlanType :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanType)
- pppdProductId :: Lens' ProvisionedProductPlanDetails (Maybe Text)
- pppdTags :: Lens' ProvisionedProductPlanDetails [Tag]
- data ProvisionedProductPlanSummary
- provisionedProductPlanSummary :: ProvisionedProductPlanSummary
- pppsProvisionProductId :: Lens' ProvisionedProductPlanSummary (Maybe Text)
- pppsProvisioningArtifactId :: Lens' ProvisionedProductPlanSummary (Maybe Text)
- pppsProvisionProductName :: Lens' ProvisionedProductPlanSummary (Maybe Text)
- pppsPlanId :: Lens' ProvisionedProductPlanSummary (Maybe Text)
- pppsPlanName :: Lens' ProvisionedProductPlanSummary (Maybe Text)
- pppsPlanType :: Lens' ProvisionedProductPlanSummary (Maybe ProvisionedProductPlanType)
- data ProvisioningArtifact
- provisioningArtifact :: ProvisioningArtifact
- paCreatedTime :: Lens' ProvisioningArtifact (Maybe UTCTime)
- paName :: Lens' ProvisioningArtifact (Maybe Text)
- paId :: Lens' ProvisioningArtifact (Maybe Text)
- paDescription :: Lens' ProvisioningArtifact (Maybe Text)
- data ProvisioningArtifactDetail
- provisioningArtifactDetail :: ProvisioningArtifactDetail
- padCreatedTime :: Lens' ProvisioningArtifactDetail (Maybe UTCTime)
- padActive :: Lens' ProvisioningArtifactDetail (Maybe Bool)
- padName :: Lens' ProvisioningArtifactDetail (Maybe Text)
- padId :: Lens' ProvisioningArtifactDetail (Maybe Text)
- padType :: Lens' ProvisioningArtifactDetail (Maybe ProvisioningArtifactType)
- padDescription :: Lens' ProvisioningArtifactDetail (Maybe Text)
- data ProvisioningArtifactParameter
- provisioningArtifactParameter :: ProvisioningArtifactParameter
- pIsNoEcho :: Lens' ProvisioningArtifactParameter (Maybe Bool)
- pParameterKey :: Lens' ProvisioningArtifactParameter (Maybe Text)
- pParameterType :: Lens' ProvisioningArtifactParameter (Maybe Text)
- pParameterConstraints :: Lens' ProvisioningArtifactParameter (Maybe ParameterConstraints)
- pDefaultValue :: Lens' ProvisioningArtifactParameter (Maybe Text)
- pDescription :: Lens' ProvisioningArtifactParameter (Maybe Text)
- data ProvisioningArtifactProperties
- provisioningArtifactProperties :: ProvisioningArtifactProperties
- papName :: Lens' ProvisioningArtifactProperties (Maybe Text)
- papType :: Lens' ProvisioningArtifactProperties (Maybe ProvisioningArtifactType)
- papDescription :: Lens' ProvisioningArtifactProperties (Maybe Text)
- papInfo :: Lens' ProvisioningArtifactProperties (HashMap Text Text)
- data ProvisioningArtifactSummary
- provisioningArtifactSummary :: ProvisioningArtifactSummary
- pasProvisioningArtifactMetadata :: Lens' ProvisioningArtifactSummary (HashMap Text Text)
- pasCreatedTime :: Lens' ProvisioningArtifactSummary (Maybe UTCTime)
- pasName :: Lens' ProvisioningArtifactSummary (Maybe Text)
- pasId :: Lens' ProvisioningArtifactSummary (Maybe Text)
- pasDescription :: Lens' ProvisioningArtifactSummary (Maybe Text)
- data ProvisioningParameter
- provisioningParameter :: ProvisioningParameter
- ppValue :: Lens' ProvisioningParameter (Maybe Text)
- ppKey :: Lens' ProvisioningParameter (Maybe Text)
- data RecordDetail
- recordDetail :: RecordDetail
- rdStatus :: Lens' RecordDetail (Maybe RecordStatus)
- rdRecordTags :: Lens' RecordDetail [RecordTag]
- rdProvisionedProductName :: Lens' RecordDetail (Maybe Text)
- rdProvisioningArtifactId :: Lens' RecordDetail (Maybe Text)
- rdCreatedTime :: Lens' RecordDetail (Maybe UTCTime)
- rdRecordType :: Lens' RecordDetail (Maybe Text)
- rdRecordId :: Lens' RecordDetail (Maybe Text)
- rdProvisionedProductType :: Lens' RecordDetail (Maybe Text)
- rdUpdatedTime :: Lens' RecordDetail (Maybe UTCTime)
- rdPathId :: Lens' RecordDetail (Maybe Text)
- rdProvisionedProductId :: Lens' RecordDetail (Maybe Text)
- rdRecordErrors :: Lens' RecordDetail [RecordError]
- rdProductId :: Lens' RecordDetail (Maybe Text)
- data RecordError
- recordError :: RecordError
- reCode :: Lens' RecordError (Maybe Text)
- reDescription :: Lens' RecordError (Maybe Text)
- data RecordOutput
- recordOutput :: RecordOutput
- roOutputValue :: Lens' RecordOutput (Maybe Text)
- roOutputKey :: Lens' RecordOutput (Maybe Text)
- roDescription :: Lens' RecordOutput (Maybe Text)
- data RecordTag
- recordTag :: RecordTag
- rtValue :: Lens' RecordTag (Maybe Text)
- rtKey :: Lens' RecordTag (Maybe Text)
- data ResourceChange
- resourceChange :: ResourceChange
- rcLogicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text)
- rcResourceType :: Lens' ResourceChange (Maybe Text)
- rcAction :: Lens' ResourceChange (Maybe ChangeAction)
- rcScope :: Lens' ResourceChange [ResourceAttribute]
- rcDetails :: Lens' ResourceChange [ResourceChangeDetail]
- rcReplacement :: Lens' ResourceChange (Maybe Replacement)
- data ResourceChangeDetail
- resourceChangeDetail :: ResourceChangeDetail
- rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text)
- rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)
- rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)
- data ResourceDetail
- resourceDetail :: ResourceDetail
- rARN :: Lens' ResourceDetail (Maybe Text)
- rCreatedTime :: Lens' ResourceDetail (Maybe UTCTime)
- rName :: Lens' ResourceDetail (Maybe Text)
- rId :: Lens' ResourceDetail (Maybe Text)
- rDescription :: Lens' ResourceDetail (Maybe Text)
- data ResourceTargetDefinition
- resourceTargetDefinition :: ResourceTargetDefinition
- rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute)
- rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation)
- rtdName :: Lens' ResourceTargetDefinition (Maybe Text)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data TagOptionDetail
- tagOptionDetail :: TagOptionDetail
- todValue :: Lens' TagOptionDetail (Maybe Text)
- todActive :: Lens' TagOptionDetail (Maybe Bool)
- todKey :: Lens' TagOptionDetail (Maybe Text)
- todId :: Lens' TagOptionDetail (Maybe Text)
- data TagOptionSummary
- tagOptionSummary :: TagOptionSummary
- tosValues :: Lens' TagOptionSummary [Text]
- tosKey :: Lens' TagOptionSummary (Maybe Text)
- data UpdateProvisioningParameter
- updateProvisioningParameter :: UpdateProvisioningParameter
- uppValue :: Lens' UpdateProvisioningParameter (Maybe Text)
- uppKey :: Lens' UpdateProvisioningParameter (Maybe Text)
- uppUsePreviousValue :: Lens' UpdateProvisioningParameter (Maybe Bool)
- data UsageInstruction
- usageInstruction :: UsageInstruction
- uiValue :: Lens' UsageInstruction (Maybe Text)
- uiType :: Lens' UsageInstruction (Maybe Text)
Service Configuration
serviceCatalog :: Service Source #
API version 2015-12-10
of the Amazon Service Catalog SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ServiceCatalog
.
InvalidParametersException
_InvalidParametersException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters provided to the operation are not valid.
DuplicateResourceException
_DuplicateResourceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is a duplicate.
TagOptionNotMigratedException
_TagOptionNotMigratedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Please use the AWS console to perform the migration process before retrying the operation.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource was not found.
InvalidStateException
_InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteConstraint
UpdateConstraint
CreateProvisionedProductPlan
CreateProduct
DescribeCopyProductStatus
TerminateProvisionedProduct
UpdateProvisionedProduct
DescribeProvisioningArtifact
ListRecordHistory
DescribeProvisionedProductPlan
AssociateTagOptionWithResource
CreateTagOption
DisassociateProductFromPortfolio
ListConstraintsForPortfolio (Paginated)
DescribeRecord
DescribeConstraint
CreateProvisioningArtifact
ListPortfolios (Paginated)
DescribeProductView
CreatePortfolioShare
ListProvisioningArtifacts
SearchProducts
SearchProvisionedProducts
DescribeProduct
DeleteProvisionedProductPlan
CreateConstraint
ListProvisionedProductPlans
ListPortfolioAccess
DisassociatePrincipalFromPortfolio
DescribeTagOption
DisassociateTagOptionFromResource
DescribePortfolio
AssociateProductWithPortfolio
ListAcceptedPortfolioShares (Paginated)
ExecuteProvisionedProductPlan
AcceptPortfolioShare
ScanProvisionedProducts
ListPrincipalsForPortfolio (Paginated)
DeleteProduct
UpdateProduct
ProvisionProduct
RejectPortfolioShare
DeleteTagOption
UpdateTagOption
ListTagOptions (Paginated)
SearchProductsAsAdmin (Paginated)
DeletePortfolio
UpdatePortfolio
ListPortfoliosForProduct (Paginated)
DescribeProductAsAdmin
DescribeProvisioningParameters
AssociatePrincipalWithPortfolio
DescribeProvisionedProduct
CopyProduct
UpdateProvisioningArtifact
DeletePortfolioShare
DeleteProvisioningArtifact
CreatePortfolio
ListLaunchPaths (Paginated)
ListResourcesForTagOption (Paginated)
Types
AccessLevelFilterKey
data AccessLevelFilterKey Source #
ChangeAction
data ChangeAction Source #
CopyOption
data CopyOption Source #
CopyProductStatus
data CopyProductStatus Source #
EvaluationType
data EvaluationType Source #
PrincipalType
data PrincipalType Source #
ProductSource
data ProductSource Source #
ProductType
data ProductType Source #
ProductViewFilterBy
data ProductViewFilterBy Source #
ProductViewSortBy
data ProductViewSortBy Source #
ProvisionedProductPlanStatus
data ProvisionedProductPlanStatus Source #
ProvisionedProductPlanType
data ProvisionedProductPlanType Source #
ProvisionedProductStatus
data ProvisionedProductStatus Source #
ProvisionedProductViewFilterBy
data ProvisionedProductViewFilterBy Source #
ProvisioningArtifactPropertyName
data ProvisioningArtifactPropertyName Source #
ProvisioningArtifactType
data ProvisioningArtifactType Source #
RecordStatus
data RecordStatus Source #
Replacement
data Replacement Source #
RequestStatus
data RequestStatus Source #
RequiresRecreation
data RequiresRecreation Source #
ResourceAttribute
data ResourceAttribute Source #
SortOrder
AccessLevelFilter
data AccessLevelFilter Source #
The access level to use to filter results.
See: accessLevelFilter
smart constructor.
accessLevelFilter :: AccessLevelFilter Source #
Creates a value of AccessLevelFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alfValue :: Lens' AccessLevelFilter (Maybe Text) Source #
The user to which the access level applies. The only supported value is Self
.
alfKey :: Lens' AccessLevelFilter (Maybe AccessLevelFilterKey) Source #
The access level. * Account
- Filter results based on the account. * Role
- Filter results based on the federated role of the specified user. * User
- Filter results based on the specified user.
CloudWatchDashboard
data CloudWatchDashboard Source #
Information about a CloudWatch dashboard.
See: cloudWatchDashboard
smart constructor.
cloudWatchDashboard :: CloudWatchDashboard Source #
Creates a value of CloudWatchDashboard
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwdName
- The name of the CloudWatch dashboard.
ConstraintDetail
data ConstraintDetail Source #
Information about a constraint.
See: constraintDetail
smart constructor.
constraintDetail :: ConstraintDetail Source #
Creates a value of ConstraintDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdConstraintId
- The identifier of the constraint.cdOwner
- The owner of the constraint.cdType
- The type of constraint. *LAUNCH
*NOTIFICATION
*TEMPLATE
cdDescription
- The description of the constraint.
cdConstraintId :: Lens' ConstraintDetail (Maybe Text) Source #
The identifier of the constraint.
cdType :: Lens' ConstraintDetail (Maybe Text) Source #
The type of constraint. * LAUNCH
* NOTIFICATION
* TEMPLATE
cdDescription :: Lens' ConstraintDetail (Maybe Text) Source #
The description of the constraint.
ConstraintSummary
data ConstraintSummary Source #
Summary information about a constraint.
See: constraintSummary
smart constructor.
constraintSummary :: ConstraintSummary Source #
Creates a value of ConstraintSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csType
- The type of constraint. *LAUNCH
*NOTIFICATION
*TEMPLATE
csDescription
- The description of the constraint.
csType :: Lens' ConstraintSummary (Maybe Text) Source #
The type of constraint. * LAUNCH
* NOTIFICATION
* TEMPLATE
csDescription :: Lens' ConstraintSummary (Maybe Text) Source #
The description of the constraint.
LaunchPathSummary
data LaunchPathSummary Source #
Summary information about a product path for a user.
See: launchPathSummary
smart constructor.
launchPathSummary :: LaunchPathSummary Source #
Creates a value of LaunchPathSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lpsConstraintSummaries
- The constraints on the portfolio-product relationship.lpsName
- The name of the portfolio to which the user was assigned.lpsId
- The identifier of the product path.lpsTags
- The tags associated with this product path.
lpsConstraintSummaries :: Lens' LaunchPathSummary [ConstraintSummary] Source #
The constraints on the portfolio-product relationship.
lpsName :: Lens' LaunchPathSummary (Maybe Text) Source #
The name of the portfolio to which the user was assigned.
ListRecordHistorySearchFilter
data ListRecordHistorySearchFilter Source #
The search filter to use when listing history records.
See: listRecordHistorySearchFilter
smart constructor.
listRecordHistorySearchFilter :: ListRecordHistorySearchFilter Source #
Creates a value of ListRecordHistorySearchFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrhsfValue
- The filter value.lrhsfKey
- The filter key. *product
- Filter results based on the specified product identifier. *provisionedproduct
- Filter results based on the provisioned product identifier.
lrhsfValue :: Lens' ListRecordHistorySearchFilter (Maybe Text) Source #
The filter value.
lrhsfKey :: Lens' ListRecordHistorySearchFilter (Maybe Text) Source #
The filter key. * product
- Filter results based on the specified product identifier. * provisionedproduct
- Filter results based on the provisioned product identifier.
ListTagOptionsFilters
data ListTagOptionsFilters Source #
Filters to use when listing TagOptions.
See: listTagOptionsFilters
smart constructor.
listTagOptionsFilters :: ListTagOptionsFilters Source #
Creates a value of ListTagOptionsFilters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltofValue
- The TagOption value.ltofActive
- The active state.ltofKey
- The TagOption key.
ltofActive :: Lens' ListTagOptionsFilters (Maybe Bool) Source #
The active state.
ParameterConstraints
data ParameterConstraints Source #
The constraints that the administrator has put on the parameter.
See: parameterConstraints
smart constructor.
parameterConstraints :: ParameterConstraints Source #
Creates a value of ParameterConstraints
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcAllowedValues
- The values that the administrator has allowed for the parameter.
pcAllowedValues :: Lens' ParameterConstraints [Text] Source #
The values that the administrator has allowed for the parameter.
PortfolioDetail
data PortfolioDetail Source #
Information about a portfolio.
See: portfolioDetail
smart constructor.
portfolioDetail :: PortfolioDetail Source #
Creates a value of PortfolioDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdARN
- The ARN assigned to the portfolio.pdCreatedTime
- The UTC time stamp of the creation time.pdId
- The portfolio identifier.pdDisplayName
- The name to use for display purposes.pdDescription
- The description of the portfolio.pdProviderName
- The name of the portfolio provider.
pdCreatedTime :: Lens' PortfolioDetail (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
pdDisplayName :: Lens' PortfolioDetail (Maybe Text) Source #
The name to use for display purposes.
pdDescription :: Lens' PortfolioDetail (Maybe Text) Source #
The description of the portfolio.
pdProviderName :: Lens' PortfolioDetail (Maybe Text) Source #
The name of the portfolio provider.
Principal
Information about a principal.
See: principal
smart constructor.
principal :: Principal Source #
Creates a value of Principal
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pPrincipalType
- The principal type. The supported value isIAM
.pPrincipalARN
- The ARN of the principal (IAM user, role, or group).
pPrincipalType :: Lens' Principal (Maybe PrincipalType) Source #
The principal type. The supported value is IAM
.
pPrincipalARN :: Lens' Principal (Maybe Text) Source #
The ARN of the principal (IAM user, role, or group).
ProductViewAggregationValue
data ProductViewAggregationValue Source #
A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
See: productViewAggregationValue
smart constructor.
productViewAggregationValue :: ProductViewAggregationValue Source #
Creates a value of ProductViewAggregationValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvavValue
- The value of the product view aggregation.pvavApproximateCount
- An approximate count of the products that match the value.
pvavValue :: Lens' ProductViewAggregationValue (Maybe Text) Source #
The value of the product view aggregation.
pvavApproximateCount :: Lens' ProductViewAggregationValue (Maybe Int) Source #
An approximate count of the products that match the value.
ProductViewDetail
data ProductViewDetail Source #
Information about a product view.
See: productViewDetail
smart constructor.
productViewDetail :: ProductViewDetail Source #
Creates a value of ProductViewDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvdStatus
- The status of the product. *AVAILABLE
- The product is ready for use. *CREATING
- Product creation has started; the product is not ready for use. *FAILED
- An action failed.pvdProductViewSummary
- Summary information about the product view.pvdCreatedTime
- The UTC time stamp of the creation time.pvdProductARN
- The ARN of the product.
pvdStatus :: Lens' ProductViewDetail (Maybe RequestStatus) Source #
The status of the product. * AVAILABLE
- The product is ready for use. * CREATING
- Product creation has started; the product is not ready for use. * FAILED
- An action failed.
pvdProductViewSummary :: Lens' ProductViewDetail (Maybe ProductViewSummary) Source #
Summary information about the product view.
pvdCreatedTime :: Lens' ProductViewDetail (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
pvdProductARN :: Lens' ProductViewDetail (Maybe Text) Source #
The ARN of the product.
ProductViewSummary
data ProductViewSummary Source #
Summary information about a product view.
See: productViewSummary
smart constructor.
productViewSummary :: ProductViewSummary Source #
Creates a value of ProductViewSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvsOwner
- The owner of the product. Contact the product administrator for the significance of this value.pvsSupportURL
- The URL information to obtain support for this Product.pvsShortDescription
- Short description of the product.pvsHasDefaultPath
- Indicates whether the product has a default path. If the product does not have a default path, callListLaunchPaths
to disambiguate between paths. Otherwise,ListLaunchPaths
is not required, and the output ofProductViewSummary
can be used directly withDescribeProvisioningParameters
.pvsDistributor
- The distributor of the product. Contact the product administrator for the significance of this value.pvsName
- The name of the product.pvsId
- The product view identifier.pvsType
- The product type. Contact the product administrator for the significance of this value. If this value isMARKETPLACE
, the product was created by AWS Marketplace.pvsSupportEmail
- The email contact information to obtain support for this Product.pvsProductId
- The product identifier.pvsSupportDescription
- The description of the support for this Product.
pvsOwner :: Lens' ProductViewSummary (Maybe Text) Source #
The owner of the product. Contact the product administrator for the significance of this value.
pvsSupportURL :: Lens' ProductViewSummary (Maybe Text) Source #
The URL information to obtain support for this Product.
pvsShortDescription :: Lens' ProductViewSummary (Maybe Text) Source #
Short description of the product.
pvsHasDefaultPath :: Lens' ProductViewSummary (Maybe Bool) Source #
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths
to disambiguate between paths. Otherwise, ListLaunchPaths
is not required, and the output of ProductViewSummary
can be used directly with DescribeProvisioningParameters
.
pvsDistributor :: Lens' ProductViewSummary (Maybe Text) Source #
The distributor of the product. Contact the product administrator for the significance of this value.
pvsType :: Lens' ProductViewSummary (Maybe ProductType) Source #
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE
, the product was created by AWS Marketplace.
pvsSupportEmail :: Lens' ProductViewSummary (Maybe Text) Source #
The email contact information to obtain support for this Product.
pvsProductId :: Lens' ProductViewSummary (Maybe Text) Source #
The product identifier.
pvsSupportDescription :: Lens' ProductViewSummary (Maybe Text) Source #
The description of the support for this Product.
ProvisionedProductAttribute
data ProvisionedProductAttribute Source #
Information about a provisioned product.
See: provisionedProductAttribute
smart constructor.
provisionedProductAttribute :: ProvisionedProductAttribute Source #
Creates a value of ProvisionedProductAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppaIdempotencyToken
- A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.ppaStatus
- The current status of the provisioned product. *AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and completed. *UNDER_CHANGE
- Transitive state, operations performed might not have valid results. Wait for anAVAILABLE
status before performing operations. *TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. *ERROR
- An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.ppaProvisioningArtifactId
- The identifier of the provisioning artifact.ppaARN
- The ARN of the provisioned product.ppaCreatedTime
- The UTC time stamp of the creation time.ppaUserARN
- The Amazon Resource Name (ARN) of the IAM user.ppaStatusMessage
- The current status message of the provisioned product.ppaName
- The user-friendly name of the provisioned product.ppaLastRecordId
- The record identifier of the last request performed on this provisioned product.ppaUserARNSession
- The ARN of the IAM user in the session. This ARN might contain a session ID.ppaId
- The identifier of the provisioned product.ppaType
- The type of provisioned product. The supported value isCFN_STACK
.ppaPhysicalId
- The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.ppaProductId
- The product identifier.ppaTags
- One or more tags.
ppaIdempotencyToken :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
ppaStatus :: Lens' ProvisionedProductAttribute (Maybe ProvisionedProductStatus) Source #
The current status of the provisioned product. * AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and completed. * UNDER_CHANGE
- Transitive state, operations performed might not have valid results. Wait for an AVAILABLE
status before performing operations. * TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. * ERROR
- An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
ppaProvisioningArtifactId :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The identifier of the provisioning artifact.
ppaARN :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The ARN of the provisioned product.
ppaCreatedTime :: Lens' ProvisionedProductAttribute (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
ppaUserARN :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM user.
ppaStatusMessage :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The current status message of the provisioned product.
ppaName :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The user-friendly name of the provisioned product.
ppaLastRecordId :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The record identifier of the last request performed on this provisioned product.
ppaUserARNSession :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The ARN of the IAM user in the session. This ARN might contain a session ID.
ppaId :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The identifier of the provisioned product.
ppaType :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The type of provisioned product. The supported value is CFN_STACK
.
ppaPhysicalId :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
ppaProductId :: Lens' ProvisionedProductAttribute (Maybe Text) Source #
The product identifier.
ProvisionedProductDetail
data ProvisionedProductDetail Source #
Information about a provisioned product.
See: provisionedProductDetail
smart constructor.
provisionedProductDetail :: ProvisionedProductDetail Source #
Creates a value of ProvisionedProductDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ppdIdempotencyToken
- A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.ppdStatus
- The current status of the provisioned product. *AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and completed. *UNDER_CHANGE
- Transitive state, operations performed might not have valid results. Wait for anAVAILABLE
status before performing operations. *TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. *ERROR
- An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.ppdARN
- The ARN of the provisioned product.ppdCreatedTime
- The UTC time stamp of the creation time.ppdStatusMessage
- The current status message of the provisioned product.ppdName
- The user-friendly name of the provisioned product.ppdLastRecordId
- The record identifier of the last request performed on this provisioned product.ppdId
- The identifier of the provisioned product.ppdType
- The type of provisioned product. The supported value isCFN_STACK
.
ppdIdempotencyToken :: Lens' ProvisionedProductDetail (Maybe Text) Source #
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
ppdStatus :: Lens' ProvisionedProductDetail (Maybe ProvisionedProductStatus) Source #
The current status of the provisioned product. * AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and completed. * UNDER_CHANGE
- Transitive state, operations performed might not have valid results. Wait for an AVAILABLE
status before performing operations. * TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. * ERROR
- An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
ppdCreatedTime :: Lens' ProvisionedProductDetail (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
ppdStatusMessage :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The current status message of the provisioned product.
ppdName :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The user-friendly name of the provisioned product.
ppdLastRecordId :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The record identifier of the last request performed on this provisioned product.
ppdId :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The identifier of the provisioned product.
ppdType :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The type of provisioned product. The supported value is CFN_STACK
.
ProvisionedProductPlanDetails
data ProvisionedProductPlanDetails Source #
Information about a plan.
See: provisionedProductPlanDetails
smart constructor.
provisionedProductPlanDetails :: ProvisionedProductPlanDetails Source #
Creates a value of ProvisionedProductPlanDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pppdStatus
- The status.pppdProvisionProductId
- The product identifier.pppdProvisioningArtifactId
- The identifier of the provisioning artifact.pppdProvisionProductName
- The user-friendly name of the provisioned product.pppdCreatedTime
- The UTC time stamp of the creation time.pppdNotificationARNs
- Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.pppdPlanId
- The plan identifier.pppdPlanName
- The name of the plan.pppdStatusMessage
- The status message.pppdUpdatedTime
- The time when the plan was last updated.pppdPathId
- The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, useListLaunchPaths
.pppdProvisioningParameters
- Parameters specified by the administrator that are required for provisioning the product.pppdPlanType
- The plan type.pppdProductId
- The product identifier.pppdTags
- One or more tags.
pppdStatus :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanStatus) Source #
The status.
pppdProvisionProductId :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The product identifier.
pppdProvisioningArtifactId :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The identifier of the provisioning artifact.
pppdProvisionProductName :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The user-friendly name of the provisioned product.
pppdCreatedTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
pppdNotificationARNs :: Lens' ProvisionedProductPlanDetails [Text] Source #
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
pppdPlanId :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The plan identifier.
pppdPlanName :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The name of the plan.
pppdStatusMessage :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The status message.
pppdUpdatedTime :: Lens' ProvisionedProductPlanDetails (Maybe UTCTime) Source #
The time when the plan was last updated.
pppdPathId :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths
.
pppdProvisioningParameters :: Lens' ProvisionedProductPlanDetails [UpdateProvisioningParameter] Source #
Parameters specified by the administrator that are required for provisioning the product.
pppdPlanType :: Lens' ProvisionedProductPlanDetails (Maybe ProvisionedProductPlanType) Source #
The plan type.
pppdProductId :: Lens' ProvisionedProductPlanDetails (Maybe Text) Source #
The product identifier.
ProvisionedProductPlanSummary
data ProvisionedProductPlanSummary Source #
Summary information about a plan.
See: provisionedProductPlanSummary
smart constructor.
provisionedProductPlanSummary :: ProvisionedProductPlanSummary Source #
Creates a value of ProvisionedProductPlanSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pppsProvisionProductId
- The product identifier.pppsProvisioningArtifactId
- The identifier of the provisioning artifact.pppsProvisionProductName
- The user-friendly name of the provisioned product.pppsPlanId
- The plan identifier.pppsPlanName
- The name of the plan.pppsPlanType
- The plan type.
pppsProvisionProductId :: Lens' ProvisionedProductPlanSummary (Maybe Text) Source #
The product identifier.
pppsProvisioningArtifactId :: Lens' ProvisionedProductPlanSummary (Maybe Text) Source #
The identifier of the provisioning artifact.
pppsProvisionProductName :: Lens' ProvisionedProductPlanSummary (Maybe Text) Source #
The user-friendly name of the provisioned product.
pppsPlanId :: Lens' ProvisionedProductPlanSummary (Maybe Text) Source #
The plan identifier.
pppsPlanName :: Lens' ProvisionedProductPlanSummary (Maybe Text) Source #
The name of the plan.
pppsPlanType :: Lens' ProvisionedProductPlanSummary (Maybe ProvisionedProductPlanType) Source #
The plan type.
ProvisioningArtifact
data ProvisioningArtifact Source #
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
See: provisioningArtifact
smart constructor.
provisioningArtifact :: ProvisioningArtifact Source #
Creates a value of ProvisioningArtifact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
paCreatedTime
- The UTC time stamp of the creation time.paName
- The name of the provisioning artifact.paId
- The identifier of the provisioning artifact.paDescription
- The description of the provisioning artifact.
paCreatedTime :: Lens' ProvisioningArtifact (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
paId :: Lens' ProvisioningArtifact (Maybe Text) Source #
The identifier of the provisioning artifact.
paDescription :: Lens' ProvisioningArtifact (Maybe Text) Source #
The description of the provisioning artifact.
ProvisioningArtifactDetail
data ProvisioningArtifactDetail Source #
Information about a provisioning artifact (also known as a version) for a product.
See: provisioningArtifactDetail
smart constructor.
provisioningArtifactDetail :: ProvisioningArtifactDetail Source #
Creates a value of ProvisioningArtifactDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
padCreatedTime
- The UTC time stamp of the creation time.padActive
- Indicates whether the product version is active.padName
- The name of the provisioning artifact.padId
- The identifier of the provisioning artifact.padType
- The type of provisioning artifact. *CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template *MARKETPLACE_AMI
- AWS Marketplace AMI *MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS ResourcespadDescription
- The description of the provisioning artifact.
padCreatedTime :: Lens' ProvisioningArtifactDetail (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
padActive :: Lens' ProvisioningArtifactDetail (Maybe Bool) Source #
Indicates whether the product version is active.
padName :: Lens' ProvisioningArtifactDetail (Maybe Text) Source #
The name of the provisioning artifact.
padId :: Lens' ProvisioningArtifactDetail (Maybe Text) Source #
The identifier of the provisioning artifact.
padType :: Lens' ProvisioningArtifactDetail (Maybe ProvisioningArtifactType) Source #
The type of provisioning artifact. * CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template * MARKETPLACE_AMI
- AWS Marketplace AMI * MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS Resources
padDescription :: Lens' ProvisioningArtifactDetail (Maybe Text) Source #
The description of the provisioning artifact.
ProvisioningArtifactParameter
data ProvisioningArtifactParameter Source #
Information about a parameter used to provision a product.
See: provisioningArtifactParameter
smart constructor.
provisioningArtifactParameter :: ProvisioningArtifactParameter Source #
Creates a value of ProvisioningArtifactParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pIsNoEcho
- If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.pParameterKey
- The parameter key.pParameterType
- The parameter type.pParameterConstraints
- Constraints that the administrator has put on a parameter.pDefaultValue
- The default value.pDescription
- The description of the parameter.
pIsNoEcho :: Lens' ProvisioningArtifactParameter (Maybe Bool) Source #
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
pParameterKey :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The parameter key.
pParameterType :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The parameter type.
pParameterConstraints :: Lens' ProvisioningArtifactParameter (Maybe ParameterConstraints) Source #
Constraints that the administrator has put on a parameter.
pDefaultValue :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The default value.
pDescription :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The description of the parameter.
ProvisioningArtifactProperties
data ProvisioningArtifactProperties Source #
Information about a provisioning artifact (also known as a version) for a product.
See: provisioningArtifactProperties
smart constructor.
provisioningArtifactProperties :: ProvisioningArtifactProperties Source #
Creates a value of ProvisioningArtifactProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
papName
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.papType
- The type of provisioning artifact. *CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template *MARKETPLACE_AMI
- AWS Marketplace AMI *MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS ResourcespapDescription
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.papInfo
- The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:LoadTemplateFromURL: "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
papName :: Lens' ProvisioningArtifactProperties (Maybe Text) Source #
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
papType :: Lens' ProvisioningArtifactProperties (Maybe ProvisioningArtifactType) Source #
The type of provisioning artifact. * CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template * MARKETPLACE_AMI
- AWS Marketplace AMI * MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS Resources
papDescription :: Lens' ProvisioningArtifactProperties (Maybe Text) Source #
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
papInfo :: Lens' ProvisioningArtifactProperties (HashMap Text Text) Source #
The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows: LoadTemplateFromURL: "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
ProvisioningArtifactSummary
data ProvisioningArtifactSummary Source #
Summary information about a provisioning artifact (also known as a version) for a product.
See: provisioningArtifactSummary
smart constructor.
provisioningArtifactSummary :: ProvisioningArtifactSummary Source #
Creates a value of ProvisioningArtifactSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pasProvisioningArtifactMetadata
- The metadata for the provisioning artifact. This is used with AWS Marketplace products.pasCreatedTime
- The UTC time stamp of the creation time.pasName
- The name of the provisioning artifact.pasId
- The identifier of the provisioning artifact.pasDescription
- The description of the provisioning artifact.
pasProvisioningArtifactMetadata :: Lens' ProvisioningArtifactSummary (HashMap Text Text) Source #
The metadata for the provisioning artifact. This is used with AWS Marketplace products.
pasCreatedTime :: Lens' ProvisioningArtifactSummary (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
pasName :: Lens' ProvisioningArtifactSummary (Maybe Text) Source #
The name of the provisioning artifact.
pasId :: Lens' ProvisioningArtifactSummary (Maybe Text) Source #
The identifier of the provisioning artifact.
pasDescription :: Lens' ProvisioningArtifactSummary (Maybe Text) Source #
The description of the provisioning artifact.
ProvisioningParameter
data ProvisioningParameter Source #
Information about a parameter used to provision a product.
See: provisioningParameter
smart constructor.
provisioningParameter :: ProvisioningParameter Source #
Creates a value of ProvisioningParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RecordDetail
data RecordDetail Source #
Information about a request operation.
See: recordDetail
smart constructor.
recordDetail :: RecordDetail Source #
Creates a value of RecordDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdStatus
- The status of the provisioned product. *CREATED
- The request was created but the operation has not started. *IN_PROGRESS
- The requested operation is in progress. *IN_PROGRESS_IN_ERROR
- The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback. *SUCCEEDED
- The requested operation has successfully completed. *FAILED
- The requested operation has unsuccessfully completed. Investigate using the error messages returned.rdRecordTags
- One or more tags.rdProvisionedProductName
- The user-friendly name of the provisioned product.rdProvisioningArtifactId
- The identifier of the provisioning artifact.rdCreatedTime
- The UTC time stamp of the creation time.rdRecordType
- The record type. *PROVISION_PRODUCT
*UPDATE_PROVISIONED_PRODUCT
*TERMINATE_PROVISIONED_PRODUCT
rdRecordId
- The identifier of the record.rdProvisionedProductType
- The type of provisioned product. The supported value isCFN_STACK
.rdUpdatedTime
- The time when the record was last updated.rdPathId
- The path identifier.rdProvisionedProductId
- The identifier of the provisioned product.rdRecordErrors
- The errors that occurred.rdProductId
- The product identifier.
rdStatus :: Lens' RecordDetail (Maybe RecordStatus) Source #
The status of the provisioned product. * CREATED
- The request was created but the operation has not started. * IN_PROGRESS
- The requested operation is in progress. * IN_PROGRESS_IN_ERROR
- The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback. * SUCCEEDED
- The requested operation has successfully completed. * FAILED
- The requested operation has unsuccessfully completed. Investigate using the error messages returned.
rdRecordTags :: Lens' RecordDetail [RecordTag] Source #
One or more tags.
rdProvisionedProductName :: Lens' RecordDetail (Maybe Text) Source #
The user-friendly name of the provisioned product.
rdProvisioningArtifactId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the provisioning artifact.
rdCreatedTime :: Lens' RecordDetail (Maybe UTCTime) Source #
The UTC time stamp of the creation time.
rdRecordType :: Lens' RecordDetail (Maybe Text) Source #
The record type. * PROVISION_PRODUCT
* UPDATE_PROVISIONED_PRODUCT
* TERMINATE_PROVISIONED_PRODUCT
rdRecordId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the record.
rdProvisionedProductType :: Lens' RecordDetail (Maybe Text) Source #
The type of provisioned product. The supported value is CFN_STACK
.
rdUpdatedTime :: Lens' RecordDetail (Maybe UTCTime) Source #
The time when the record was last updated.
rdProvisionedProductId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the provisioned product.
rdRecordErrors :: Lens' RecordDetail [RecordError] Source #
The errors that occurred.
rdProductId :: Lens' RecordDetail (Maybe Text) Source #
The product identifier.
RecordError
data RecordError Source #
The error code and description resulting from an operation.
See: recordError
smart constructor.
recordError :: RecordError Source #
Creates a value of RecordError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
reCode
- The numeric value of the error.reDescription
- The description of the error.
reDescription :: Lens' RecordError (Maybe Text) Source #
The description of the error.
RecordOutput
data RecordOutput Source #
The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
See: recordOutput
smart constructor.
recordOutput :: RecordOutput Source #
Creates a value of RecordOutput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roOutputValue
- The output value.roOutputKey
- The output key.roDescription
- The description of the output.
roOutputValue :: Lens' RecordOutput (Maybe Text) Source #
The output value.
roOutputKey :: Lens' RecordOutput (Maybe Text) Source #
The output key.
roDescription :: Lens' RecordOutput (Maybe Text) Source #
The description of the output.
RecordTag
Information about a tag, which is a key-value pair.
See: recordTag
smart constructor.
ResourceChange
data ResourceChange Source #
Information about a resource change that will occur when a plan is executed.
See: resourceChange
smart constructor.
resourceChange :: ResourceChange Source #
Creates a value of ResourceChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcLogicalResourceId
- The ID of the resource, as defined in the CloudFormation template.rcPhysicalResourceId
- The ID of the resource, if it was already created.rcResourceType
- The type of resource.rcAction
- The change action.rcScope
- The change scope.rcDetails
- Information about the resource changes.rcReplacement
- If the change type isModify
, indicates whether the existing resource is deleted and replaced with a new one.
rcLogicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The ID of the resource, as defined in the CloudFormation template.
rcPhysicalResourceId :: Lens' ResourceChange (Maybe Text) Source #
The ID of the resource, if it was already created.
rcResourceType :: Lens' ResourceChange (Maybe Text) Source #
The type of resource.
rcAction :: Lens' ResourceChange (Maybe ChangeAction) Source #
The change action.
rcScope :: Lens' ResourceChange [ResourceAttribute] Source #
The change scope.
rcDetails :: Lens' ResourceChange [ResourceChangeDetail] Source #
Information about the resource changes.
rcReplacement :: Lens' ResourceChange (Maybe Replacement) Source #
If the change type is Modify
, indicates whether the existing resource is deleted and replaced with a new one.
ResourceChangeDetail
data ResourceChangeDetail Source #
Information about a change to a resource attribute.
See: resourceChangeDetail
smart constructor.
resourceChangeDetail :: ResourceChangeDetail Source #
Creates a value of ResourceChangeDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcdCausingEntity
- The ID of the entity that caused the change.rcdEvaluation
- For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.rcdTarget
- Information about the resource attribute to be modified.
rcdCausingEntity :: Lens' ResourceChangeDetail (Maybe Text) Source #
The ID of the entity that caused the change.
rcdEvaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType) Source #
For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.
rcdTarget :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition) Source #
Information about the resource attribute to be modified.
ResourceDetail
data ResourceDetail Source #
Information about a resource.
See: resourceDetail
smart constructor.
resourceDetail :: ResourceDetail Source #
Creates a value of ResourceDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rARN
- The ARN of the resource.rCreatedTime
- The creation time of the resource.rName
- The name of the resource.rId
- The identifier of the resource.rDescription
- The description of the resource.
rCreatedTime :: Lens' ResourceDetail (Maybe UTCTime) Source #
The creation time of the resource.
rDescription :: Lens' ResourceDetail (Maybe Text) Source #
The description of the resource.
ResourceTargetDefinition
data ResourceTargetDefinition Source #
Information about a change to a resource attribute.
See: resourceTargetDefinition
smart constructor.
resourceTargetDefinition :: ResourceTargetDefinition Source #
Creates a value of ResourceTargetDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtdAttribute
- The attribute to be changed.rtdRequiresRecreation
- If the attribute isProperties
, indicates whether a change to this property causes the resource to be re-created.rtdName
- If the attribute isProperties
, the value is the name of the property. Otherwise, the value is null.
rtdAttribute :: Lens' ResourceTargetDefinition (Maybe ResourceAttribute) Source #
The attribute to be changed.
rtdRequiresRecreation :: Lens' ResourceTargetDefinition (Maybe RequiresRecreation) Source #
If the attribute is Properties
, indicates whether a change to this property causes the resource to be re-created.
rtdName :: Lens' ResourceTargetDefinition (Maybe Text) Source #
If the attribute is Properties
, the value is the name of the property. Otherwise, the value is null.
Tag
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
See: tag
smart constructor.
TagOptionDetail
data TagOptionDetail Source #
Information about a TagOption.
See: tagOptionDetail
smart constructor.
tagOptionDetail :: TagOptionDetail Source #
Creates a value of TagOptionDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
TagOptionSummary
data TagOptionSummary Source #
Summary information about a TagOption.
See: tagOptionSummary
smart constructor.
tagOptionSummary :: TagOptionSummary Source #
Creates a value of TagOptionSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UpdateProvisioningParameter
data UpdateProvisioningParameter Source #
The parameter key-value pair used to update a provisioned product.
See: updateProvisioningParameter
smart constructor.
updateProvisioningParameter :: UpdateProvisioningParameter Source #
Creates a value of UpdateProvisioningParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uppValue
- The parameter value.uppKey
- The parameter key.uppUsePreviousValue
- If set to true,Value
is ignored and the previous parameter value is kept.
uppUsePreviousValue :: Lens' UpdateProvisioningParameter (Maybe Bool) Source #
If set to true, Value
is ignored and the previous parameter value is kept.
UsageInstruction
data UsageInstruction Source #
Additional information provided by the administrator.
See: usageInstruction
smart constructor.
usageInstruction :: UsageInstruction Source #
Creates a value of UsageInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired: