Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- ProductViewFilterBy
- ProductViewSortBy
- RecordStatus
- SortOrder
- ConstraintSummary
- LaunchPathSummary
- ListRecordHistorySearchFilter
- ParameterConstraints
- ProductViewAggregationValue
- ProductViewSummary
- ProvisionedProductDetail
- ProvisioningArtifact
- ProvisioningArtifactParameter
- ProvisioningParameter
- RecordDetail
- RecordError
- RecordOutput
- RecordTag
- Tag
- UpdateProvisioningParameter
- UsageInstruction
AWS Service Catalog
Overview
AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts.
Additional Resources
- serviceCatalog :: Service
- _InvalidParametersException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.ServiceCatalog.TerminateProvisionedProduct
- module Network.AWS.ServiceCatalog.UpdateProvisionedProduct
- module Network.AWS.ServiceCatalog.ListRecordHistory
- module Network.AWS.ServiceCatalog.DescribeRecord
- module Network.AWS.ServiceCatalog.DescribeProductView
- module Network.AWS.ServiceCatalog.SearchProducts
- module Network.AWS.ServiceCatalog.DescribeProduct
- module Network.AWS.ServiceCatalog.ScanProvisionedProducts
- module Network.AWS.ServiceCatalog.ProvisionProduct
- module Network.AWS.ServiceCatalog.DescribeProvisioningParameters
- module Network.AWS.ServiceCatalog.ListLaunchPaths
- data ProductViewFilterBy
- data ProductViewSortBy
- data RecordStatus
- data SortOrder
- 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 ParameterConstraints
- parameterConstraints :: ParameterConstraints
- pcAllowedValues :: Lens' ParameterConstraints [Text]
- data ProductViewAggregationValue
- productViewAggregationValue :: ProductViewAggregationValue
- pvavValue :: Lens' ProductViewAggregationValue (Maybe Text)
- pvavApproximateCount :: Lens' ProductViewAggregationValue (Maybe Int)
- 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 Text)
- pvsSupportEmail :: Lens' ProductViewSummary (Maybe Text)
- pvsProductId :: Lens' ProductViewSummary (Maybe Text)
- pvsSupportDescription :: Lens' ProductViewSummary (Maybe Text)
- data ProvisionedProductDetail
- provisionedProductDetail :: ProvisionedProductDetail
- ppdIdempotencyToken :: Lens' ProvisionedProductDetail (Maybe Text)
- ppdStatus :: Lens' ProvisionedProductDetail (Maybe RecordStatus)
- 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 ProvisioningArtifact
- provisioningArtifact :: ProvisioningArtifact
- paCreatedTime :: Lens' ProvisioningArtifact (Maybe UTCTime)
- paName :: Lens' ProvisioningArtifact (Maybe Text)
- paId :: Lens' ProvisioningArtifact (Maybe Text)
- paDescription :: Lens' ProvisioningArtifact (Maybe Text)
- data ProvisioningArtifactParameter
- provisioningArtifactParameter :: ProvisioningArtifactParameter
- papIsNoEcho :: Lens' ProvisioningArtifactParameter (Maybe Bool)
- papParameterKey :: Lens' ProvisioningArtifactParameter (Maybe Text)
- papParameterType :: Lens' ProvisioningArtifactParameter (Maybe Text)
- papParameterConstraints :: Lens' ProvisioningArtifactParameter (Maybe ParameterConstraints)
- papDefaultValue :: Lens' ProvisioningArtifactParameter (Maybe Text)
- papDescription :: Lens' ProvisioningArtifactParameter (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 Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (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 invalid.
DuplicateResourceException
_DuplicateResourceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is a duplicate.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource was not found.
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.
TerminateProvisionedProduct
UpdateProvisionedProduct
ListRecordHistory
DescribeRecord
DescribeProductView
SearchProducts
DescribeProduct
ScanProvisionedProducts
ProvisionProduct
DescribeProvisioningParameters
ListLaunchPaths
Types
ProductViewFilterBy
data ProductViewFilterBy Source #
ProductViewSortBy
data ProductViewSortBy Source #
RecordStatus
data RecordStatus Source #
SortOrder
ConstraintSummary
data ConstraintSummary Source #
An administrator-specified constraint to apply when provisioning a product.
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:
csDescription :: Lens' ConstraintSummary (Maybe Text) Source #
The text description of the constraint.
LaunchPathSummary
data LaunchPathSummary Source #
Summary information about a path for a user to have access to a specified product.
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 :: Lens' LaunchPathSummary [ConstraintSummary] Source #
List of constraints on the portfolio-product relationship.
lpsName :: Lens' LaunchPathSummary (Maybe Text) Source #
Corresponds to the name of the portfolio to which the user was assigned.
ListRecordHistorySearchFilter
data ListRecordHistorySearchFilter Source #
The search filter to limit results when listing request 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 :: Lens' ListRecordHistorySearchFilter (Maybe Text) Source #
The filter value for Key
.
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 :: Lens' ParameterConstraints [Text] Source #
The values that the administrator has allowed for the parameter.
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 :: 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.
ProductViewSummary
data ProductViewSummary Source #
The summary metadata about the specified product.
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 :: 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 #
A value of false
indicates that the product does not have a default path, while a value of true
indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation 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 Text) Source #
The product type. Contact the product administrator for the significance of this value.
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.
ProvisionedProductDetail
data ProvisionedProductDetail Source #
Detailed information about a ProvisionedProduct object.
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 :: Lens' ProvisionedProductDetail (Maybe Text) Source #
An idempotency token that uniquely identifies this ProvisionedProduct.
ppdStatus :: Lens' ProvisionedProductDetail (Maybe RecordStatus) Source #
The current status of the ProvisionedProduct.
ppdARN :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The ARN associated with the ProvisionedProduct object.
ppdCreatedTime :: Lens' ProvisionedProductDetail (Maybe UTCTime) Source #
The time the ProvisionedProduct was created.
ppdStatusMessage :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The current status message of the ProvisionedProduct.
ppdName :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The user-friendly name of the ProvisionedProduct object.
ppdLastRecordId :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The record identifier of the last request performed on this ProvisionedProduct object.
ppdId :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The identifier of the ProvisionedProduct object.
ppdType :: Lens' ProvisionedProductDetail (Maybe Text) Source #
The type of the ProvisionedProduct object.
ProvisioningArtifact
data ProvisioningArtifact Source #
Contains information indicating the ways in which a product can be provisioned.
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 :: Lens' ProvisioningArtifact (Maybe UTCTime) Source #
The time that the artifact was created by the Administrator.
paDescription :: Lens' ProvisioningArtifact (Maybe Text) Source #
The text description of the artifact.
ProvisioningArtifactParameter
data ProvisioningArtifactParameter Source #
A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.
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:
papIsNoEcho :: 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.
papParameterKey :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The parameter key.
papParameterType :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The parameter type.
papParameterConstraints :: Lens' ProvisioningArtifactParameter (Maybe ParameterConstraints) Source #
The list of constraints that the administrator has put on the parameter.
papDefaultValue :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The default value for this parameter.
papDescription :: Lens' ProvisioningArtifactParameter (Maybe Text) Source #
The text description of the parameter.
ProvisioningParameter
data ProvisioningParameter Source #
The arameter key/value pairs 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:
ppValue :: Lens' ProvisioningParameter (Maybe Text) Source #
The value to use for provisioning. Any constraints on this value can be found in ProvisioningArtifactParameter
for Key
.
ppKey :: Lens' ProvisioningParameter (Maybe Text) Source #
The ParameterKey
parameter from DescribeProvisioningParameters.
RecordDetail
data RecordDetail Source #
The full details of a specific ProvisionedProduct object.
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 :: Lens' RecordDetail (Maybe RecordStatus) Source #
The status of the ProvisionedProduct object.
rdRecordTags :: Lens' RecordDetail [RecordTag] Source #
List of tags associated with this record.
rdProvisionedProductName :: Lens' RecordDetail (Maybe Text) Source #
The user-friendly name of the ProvisionedProduct object.
rdProvisioningArtifactId :: Lens' RecordDetail (Maybe Text) Source #
The provisioning artifact identifier for this product.
rdCreatedTime :: Lens' RecordDetail (Maybe UTCTime) Source #
The time when the record for the ProvisionedProduct object was created.
rdRecordType :: Lens' RecordDetail (Maybe Text) Source #
The record type for this record.
rdRecordId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the ProvisionedProduct object record.
rdProvisionedProductType :: Lens' RecordDetail (Maybe Text) Source #
The type of the ProvisionedProduct object.
rdUpdatedTime :: Lens' RecordDetail (Maybe UTCTime) Source #
The time when the record for the ProvisionedProduct object was last updated.
rdPathId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the path for this product's provisioning.
rdProvisionedProductId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the ProvisionedProduct object.
rdRecordErrors :: Lens' RecordDetail [RecordError] Source #
A list of errors that occurred while processing the request.
rdProductId :: Lens' RecordDetail (Maybe Text) Source #
The identifier of the product.
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:
reDescription :: Lens' RecordError (Maybe Text) Source #
The text description of the error.
RecordOutput
data RecordOutput Source #
An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for 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 :: Lens' RecordOutput (Maybe Text) Source #
The output value.
roOutputKey :: Lens' RecordOutput (Maybe Text) Source #
The output key.
roDescription :: Lens' RecordOutput (Maybe Text) Source #
The text description of the output.
RecordTag
A tag associated with the record, stored as a key-value pair.
See: recordTag
smart constructor.
Tag
Optional key/value pairs to associate with this provisioning. These tags are propagated to the resources created in the provisioning.
See: tag
smart constructor.
UpdateProvisioningParameter
data UpdateProvisioningParameter Source #
The parameter key/value pair used to update a ProvisionedProduct object. If UsePreviousValue
is set to true, Value
is ignored and the value for Key
is kept as previously set (current value).
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 :: Lens' UpdateProvisioningParameter (Maybe Text) Source #
The value to use for updating the product provisioning. Any constraints on this value can be found in the ProvisioningArtifactParameter
parameter for Key
.
uppKey :: Lens' UpdateProvisioningParameter (Maybe Text) Source #
The ParameterKey
parameter from DescribeProvisioningParameters.
uppUsePreviousValue :: Lens' UpdateProvisioningParameter (Maybe Bool) Source #
If true, uses the currently set value for Key
, ignoring Value
.
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: