1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
.. Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
International License (the "License"). You may not use this file except in compliance with the
License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/.
This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language governing permissions and
limitations under the License.
.. _aws-boto3-iam-examples-server-certs:
####################################
Working with IAM server certificates
####################################
This Python example shows you how to carry out basic tasks in managing server certificates for HTTPS connections.
The scenario
============
To enable HTTPS connections to your website or application on AWS, you need an SSL/TLS server certificate.
To use a certificate that you obtained from an external provider with your website or application on AWS,
you must upload the certificate to IAM or import it into AWS Certificate Manager.
In this example, python code is used to handle server certificates in IAM. The code uses the
Amazon Web Services (AWS) SDK for Python to manage server certificates using these methods of the
IAM client class:
* `get_paginator('list_server_certificates') <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.update_access_key>`_.
* `get_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.get_server_certificate>`_.
* `update_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.update_server_certificate>`_.
* `delete_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.delete_server_certificate>`_.
All the example code for the Amazon Web Services (AWS) SDK for Python is available `here on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/example_code>`_.
For more information about server certificates, see `Working with Server Certificates <http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html>`_
in the *IAM User Guide*.
Prerequisite tasks
=================
To set up and run this example, you must first configure your AWS credentials, as described in :doc:`quickstart`.
List your server certificates
=============================
List the server certificates stored in IAM. If none exist, the action returns an empty list.
The example below shows how to:
* List server certificates using
`get_paginator('list_server_certificates') <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.get_paginator>`_.
For more information about paginators see, :doc:`paginators`
Example
-------
.. code-block:: python
import boto3
# Create IAM client
iam = boto3.client('iam')
# List server certificates through the pagination interface
paginator = iam.get_paginator('list_server_certificates')
for response in paginator.paginate():
print(response['ServerCertificateMetadataList'])
Get a server certificate
========================
Get information about the specified server certificate stored in IAM.
The example below shows how to:
* Get a server certificate using
`get_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.get_server_certificate>`_.
Example
-------
.. code-block:: python
import boto3
# Create IAM client
iam = boto3.client('iam')
# Get the server certificate
response = iam.get_server_certificate(ServerCertificateName='CERTIFICATE_NAME')
print(response['ServerCertificate'])
Update a server certificate
===========================
Update the name and/or the path of the specified server certificate stored in IAM.
The example below shows how to:
* Update a server certificate using
`update_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.update_server_certificate>`_.
Example
-------
.. code-block:: python
import boto3
# Create IAM client
iam = boto3.client('iam')
# Update the name of the server certificate
iam.update_server_certificate(
ServerCertificateName='CERTIFICATE_NAME',
NewServerCertificateName='NEW_CERTIFICATE_NAME'
)
Delete a server certificate
===========================
Delete the specified server certificate.
The example below shows how to:
* Delete a server certificate using
`delete_server_certificate <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iam.html#IAM.Client.delete_server_certificate>`_.
Example
-------
.. code-block:: python
import boto3
# Create IAM client
iam = boto3.client('iam')
# Delete the server certificate
iam.delete_server_certificate(
ServerCertificateName='CERTIFICATE_NAME'
)
|
