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 |
Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.
For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate
. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.
- uploadServerCertificate :: Text -> Text -> Text -> UploadServerCertificate
- data UploadServerCertificate
- uscPath :: Lens' UploadServerCertificate (Maybe Text)
- uscCertificateChain :: Lens' UploadServerCertificate (Maybe Text)
- uscServerCertificateName :: Lens' UploadServerCertificate Text
- uscCertificateBody :: Lens' UploadServerCertificate Text
- uscPrivateKey :: Lens' UploadServerCertificate Text
- uploadServerCertificateResponse :: Int -> UploadServerCertificateResponse
- data UploadServerCertificateResponse
- ursServerCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata)
- ursResponseStatus :: Lens' UploadServerCertificateResponse Int
Creating a Request
uploadServerCertificate Source #
:: Text | |
-> Text | |
-> Text | |
-> UploadServerCertificate |
Creates a value of UploadServerCertificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UploadServerCertificate Source #
See: uploadServerCertificate
smart constructor.
Request Lenses
uscPath :: Lens' UploadServerCertificate (Maybe Text) Source #
The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the '--path' option. The path must begin with '\/cloudfront' and must include a trailing slash (for example, '\/cloudfront\/test\/').
uscCertificateChain :: Lens' UploadServerCertificate (Maybe Text) Source #
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range (\u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).
uscServerCertificateName :: Lens' UploadServerCertificate Text Source #
The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.'-
uscCertificateBody :: Lens' UploadServerCertificate Text Source #
The contents of the public key certificate in PEM-encoded format.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range (\u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).
uscPrivateKey :: Lens' UploadServerCertificate Text Source #
The contents of the private key in PEM-encoded format.
The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\u0020) through end of the ASCII character range (\u00FF). It also includes the special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D).
Destructuring the Response
uploadServerCertificateResponse Source #
Creates a value of UploadServerCertificateResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UploadServerCertificateResponse Source #
Contains the response to a successful UploadServerCertificate request.
See: uploadServerCertificateResponse
smart constructor.
Response Lenses
ursServerCertificateMetadata :: Lens' UploadServerCertificateResponse (Maybe ServerCertificateMetadata) Source #
The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.
ursResponseStatus :: Lens' UploadServerCertificateResponse Int Source #
The response status code.