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 |
Creates a new constraint.
- createConstraint :: Text -> Text -> Text -> Text -> Text -> CreateConstraint
- data CreateConstraint
- ccAcceptLanguage :: Lens' CreateConstraint (Maybe Text)
- ccDescription :: Lens' CreateConstraint (Maybe Text)
- ccPortfolioId :: Lens' CreateConstraint Text
- ccProductId :: Lens' CreateConstraint Text
- ccParameters :: Lens' CreateConstraint Text
- ccType :: Lens' CreateConstraint Text
- ccIdempotencyToken :: Lens' CreateConstraint Text
- createConstraintResponse :: Int -> CreateConstraintResponse
- data CreateConstraintResponse
- ccrsStatus :: Lens' CreateConstraintResponse (Maybe RequestStatus)
- ccrsConstraintDetail :: Lens' CreateConstraintResponse (Maybe ConstraintDetail)
- ccrsConstraintParameters :: Lens' CreateConstraintResponse (Maybe Text)
- ccrsResponseStatus :: Lens' CreateConstraintResponse Int
Creating a Request
Creates a value of CreateConstraint
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccAcceptLanguage
- The language code to use for this operation. Supported language codes are as follows: "en" (English) "jp" (Japanese) "zh" (Chinese) If no code is specified, "en" is used as the default.ccDescription
- The text description of the constraint.ccPortfolioId
- The portfolio identifier.ccProductId
- The product identifier.ccParameters
- The constraint parameters.ccType
- The type of the constraint.ccIdempotencyToken
- A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
data CreateConstraint Source #
See: createConstraint
smart constructor.
Request Lenses
ccAcceptLanguage :: Lens' CreateConstraint (Maybe Text) Source #
The language code to use for this operation. Supported language codes are as follows: "en" (English) "jp" (Japanese) "zh" (Chinese) If no code is specified, "en" is used as the default.
ccDescription :: Lens' CreateConstraint (Maybe Text) Source #
The text description of the constraint.
ccPortfolioId :: Lens' CreateConstraint Text Source #
The portfolio identifier.
ccProductId :: Lens' CreateConstraint Text Source #
The product identifier.
ccParameters :: Lens' CreateConstraint Text Source #
The constraint parameters.
ccIdempotencyToken :: Lens' CreateConstraint Text Source #
A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
Destructuring the Response
createConstraintResponse Source #
Creates a value of CreateConstraintResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccrsStatus
- The status of the current request.ccrsConstraintDetail
- The resulting detailed constraint information.ccrsConstraintParameters
- The resulting constraint parameters.ccrsResponseStatus
- -- | The response status code.
data CreateConstraintResponse Source #
See: createConstraintResponse
smart constructor.
Response Lenses
ccrsStatus :: Lens' CreateConstraintResponse (Maybe RequestStatus) Source #
The status of the current request.
ccrsConstraintDetail :: Lens' CreateConstraintResponse (Maybe ConstraintDetail) Source #
The resulting detailed constraint information.
ccrsConstraintParameters :: Lens' CreateConstraintResponse (Maybe Text) Source #
The resulting constraint parameters.
ccrsResponseStatus :: Lens' CreateConstraintResponse Int Source #
- - | The response status code.