get_server_certificate¶
Operation¶
get_server_certificate
¶
get_server_certificate(request: GetServerCertificateInput | GetServerCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetServerCertificateInputDict]) -> GetServerCertificateOutput
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetServerCertificateInput | GetServerCertificateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetServerCertificateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetServerCertificateOutput
|
An instance of |
get_server_certificate
async
¶
get_server_certificate(request: GetServerCertificateInput | GetServerCertificateInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetServerCertificateInputDict]) -> GetServerCertificateOutput
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetServerCertificateInput | GetServerCertificateInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetServerCertificateInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetServerCertificateOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetServerCertificateInputDict
¶
Bases: TypedDict
Dictionary form of GetServerCertificateInput.
Attributes¶
server_certificate_name
instance-attribute
¶
The name of the server certificate you want to retrieve information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
GetServerCertificateInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetServerCertificateInput structure.
Attributes¶
server_certificate_name
class-attribute
instance-attribute
¶
server_certificate_name: str | None = ...
The name of the server certificate you want to retrieve information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
GetServerCertificateOutput
dataclass
¶
Bases: _SerdeShape
Contains the response to a successful GetServerCertificate request.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
server_certificate
instance-attribute
¶
server_certificate: ServerCertificate
A structure containing details about the server certificate.