| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IAM.UpdateSAMLProvider
Description
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
Synopsis
- data UpdateSAMLProvider = UpdateSAMLProvider' {}
- newUpdateSAMLProvider :: Text -> Text -> UpdateSAMLProvider
- updateSAMLProvider_sAMLMetadataDocument :: Lens' UpdateSAMLProvider Text
- updateSAMLProvider_sAMLProviderArn :: Lens' UpdateSAMLProvider Text
- data UpdateSAMLProviderResponse = UpdateSAMLProviderResponse' {}
- newUpdateSAMLProviderResponse :: Int -> UpdateSAMLProviderResponse
- updateSAMLProviderResponse_sAMLProviderArn :: Lens' UpdateSAMLProviderResponse (Maybe Text)
- updateSAMLProviderResponse_httpStatus :: Lens' UpdateSAMLProviderResponse Int
Creating a Request
data UpdateSAMLProvider Source #
See: newUpdateSAMLProvider smart constructor.
Constructors
| UpdateSAMLProvider' | |
Fields
| |
Instances
newUpdateSAMLProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSAMLProvider |
Create a value of UpdateSAMLProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sAMLMetadataDocument:UpdateSAMLProvider', updateSAMLProvider_sAMLMetadataDocument - An XML document generated by an identity provider (IdP) that supports
SAML 2.0. The document includes the issuer's name, expiration
information, and keys that can be used to validate the SAML
authentication response (assertions) that are received from the IdP. You
must generate the metadata document using the identity management
software that is used as your organization's IdP.
$sel:sAMLProviderArn:UpdateSAMLProvider', updateSAMLProvider_sAMLProviderArn - The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Request Lenses
updateSAMLProvider_sAMLMetadataDocument :: Lens' UpdateSAMLProvider Text Source #
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
updateSAMLProvider_sAMLProviderArn :: Lens' UpdateSAMLProvider Text Source #
The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Destructuring the Response
data UpdateSAMLProviderResponse Source #
Contains the response to a successful UpdateSAMLProvider request.
See: newUpdateSAMLProviderResponse smart constructor.
Constructors
| UpdateSAMLProviderResponse' | |
Fields
| |
Instances
newUpdateSAMLProviderResponse Source #
Create a value of UpdateSAMLProviderResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sAMLProviderArn:UpdateSAMLProvider', updateSAMLProviderResponse_sAMLProviderArn - The Amazon Resource Name (ARN) of the SAML provider that was updated.
$sel:httpStatus:UpdateSAMLProviderResponse', updateSAMLProviderResponse_httpStatus - The response's http status code.
Response Lenses
updateSAMLProviderResponse_sAMLProviderArn :: Lens' UpdateSAMLProviderResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SAML provider that was updated.
updateSAMLProviderResponse_httpStatus :: Lens' UpdateSAMLProviderResponse Int Source #
The response's http status code.