Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpacesWeb.UpdateIdentityProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the identity provider.

Synopsis

Creating a Request

data UpdateIdentityProvider Source #

See: newUpdateIdentityProvider smart constructor.

Constructors

UpdateIdentityProvider'

Fields

clientToken :: Maybe Text
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.
If you do not specify a client token, one is automatically generated by the AWS SDK.
identityProviderDetails :: Maybe (Sensitive (HashMap Text Text))
The details of the identity provider. The following list describes the provider detail keys for each identity provider type.
- For Google and Login with Amazon:
  - ```
  client_id
```
- ```
client_secret
```
  - ```
  authorize_scopes
```
- For Facebook:
  - ```
  client_id
```
- ```
client_secret
```
  - ```
  authorize_scopes
```
- ```
api_version
```
- For Sign in with Apple:
  - ```
  client_id
```
- ```
team_id
```
  - ```
  key_id
```
- ```
private_key
```
  - ```
  authorize_scopes
```
- For OIDC providers:
  - ```
  client_id
```
- ```
client_secret
```
  - ```
  attributes_request_method
```
- ```
oidc_issuer
```
  - ```
  authorize_scopes
```
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
- For SAML providers:
  - MetadataFile OR MetadataURL
  - IDPSignout (boolean) optional
identityProviderName :: Maybe (Sensitive Text)
The name of the identity provider.
identityProviderType :: Maybe IdentityProviderType
The type of the identity provider.
identityProviderArn :: Text
The ARN of the identity provider.

Instances

Instances details

ToJSON UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods toJSON :: UpdateIdentityProvider -> Value # toEncoding :: UpdateIdentityProvider -> Encoding # toJSONList :: [UpdateIdentityProvider] -> Value # toEncodingList :: [UpdateIdentityProvider] -> Encoding #
ToHeaders UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods toHeaders :: UpdateIdentityProvider -> [Header] #
ToPath UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods toPath :: UpdateIdentityProvider -> ByteString #
ToQuery UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods toQuery :: UpdateIdentityProvider -> QueryString #
AWSRequest UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Associated Types type AWSResponse UpdateIdentityProvider # Methods request :: (Service -> Service) -> UpdateIdentityProvider -> Request UpdateIdentityProvider # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateIdentityProvider))) #
Generic UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Associated Types type Rep UpdateIdentityProvider :: Type -> Type # Methods from :: UpdateIdentityProvider -> Rep UpdateIdentityProvider x # to :: Rep UpdateIdentityProvider x -> UpdateIdentityProvider #
Show UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods showsPrec :: Int -> UpdateIdentityProvider -> ShowS # show :: UpdateIdentityProvider -> String # showList :: [UpdateIdentityProvider] -> ShowS #
NFData UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods rnf :: UpdateIdentityProvider -> () #
Eq UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods (==) :: UpdateIdentityProvider -> UpdateIdentityProvider -> Bool # (/=) :: UpdateIdentityProvider -> UpdateIdentityProvider -> Bool #
Hashable UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods hashWithSalt :: Int -> UpdateIdentityProvider -> Int # hash :: UpdateIdentityProvider -> Int #
type AWSResponse UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider type AWSResponse UpdateIdentityProvider = UpdateIdentityProviderResponse
type Rep UpdateIdentityProvider Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider type Rep UpdateIdentityProvider = D1 ('MetaData "UpdateIdentityProvider" "Amazonka.WorkSpacesWeb.UpdateIdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "UpdateIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityProviderDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "identityProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "identityProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderType)) :: S1 ('MetaSel ('Just "identityProviderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateIdentityProvider Source #

Arguments

:: Text	`UpdateIdentityProvider`
-> UpdateIdentityProvider

Create a value of UpdateIdentityProvider 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:clientToken:UpdateIdentityProvider', updateIdentityProvider_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

UpdateIdentityProvider, updateIdentityProvider_identityProviderDetails - The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

For Google and Login with Amazon:
- ```
client_id
```
- ```
client_secret
```
- ```
authorize_scopes
```

For Facebook:

```
client_id
```
```
client_secret
```
```
authorize_scopes
```
```
api_version
```

For Sign in with Apple:

```
client_id
```
```
team_id
```
```
key_id
```
```
private_key
```
```
authorize_scopes
```

For OIDC providers:
- ```
client_id
```
- ```
client_secret
```
- ```
attributes_request_method
```
- ```
oidc_issuer
```
- ```
authorize_scopes
```
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignout (boolean) optional

UpdateIdentityProvider, updateIdentityProvider_identityProviderName - The name of the identity provider.

UpdateIdentityProvider, updateIdentityProvider_identityProviderType - The type of the identity provider.

UpdateIdentityProvider, updateIdentityProvider_identityProviderArn - The ARN of the identity provider.

Request Lenses

updateIdentityProvider_clientToken :: Lens' UpdateIdentityProvider (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

updateIdentityProvider_identityProviderDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text)) Source #

The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

For Google and Login with Amazon:
- ```
client_id
```
- ```
client_secret
```
- ```
authorize_scopes
```

For Facebook:

```
client_id
```
```
client_secret
```
```
authorize_scopes
```
```
api_version
```

For Sign in with Apple:

```
client_id
```
```
team_id
```
```
key_id
```
```
private_key
```
```
authorize_scopes
```

For OIDC providers:
- ```
client_id
```
- ```
client_secret
```
- ```
attributes_request_method
```
- ```
oidc_issuer
```
- ```
authorize_scopes
```
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignout (boolean) optional

updateIdentityProvider_identityProviderName :: Lens' UpdateIdentityProvider (Maybe Text) Source #

The name of the identity provider.

updateIdentityProvider_identityProviderType :: Lens' UpdateIdentityProvider (Maybe IdentityProviderType) Source #

The type of the identity provider.

updateIdentityProvider_identityProviderArn :: Lens' UpdateIdentityProvider Text Source #

The ARN of the identity provider.

Destructuring the Response

data UpdateIdentityProviderResponse Source #

See: newUpdateIdentityProviderResponse smart constructor.

Constructors

UpdateIdentityProviderResponse'
Fields httpStatus :: Int The response's http status code. identityProvider :: IdentityProvider The identity provider.

Instances

Instances details

Generic UpdateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Associated Types type Rep UpdateIdentityProviderResponse :: Type -> Type # Methods from :: UpdateIdentityProviderResponse -> Rep UpdateIdentityProviderResponse x # to :: Rep UpdateIdentityProviderResponse x -> UpdateIdentityProviderResponse #
Show UpdateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods showsPrec :: Int -> UpdateIdentityProviderResponse -> ShowS # show :: UpdateIdentityProviderResponse -> String # showList :: [UpdateIdentityProviderResponse] -> ShowS #
NFData UpdateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods rnf :: UpdateIdentityProviderResponse -> () #
Eq UpdateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider Methods (==) :: UpdateIdentityProviderResponse -> UpdateIdentityProviderResponse -> Bool # (/=) :: UpdateIdentityProviderResponse -> UpdateIdentityProviderResponse -> Bool #
type Rep UpdateIdentityProviderResponse Source #
Instance details Defined in Amazonka.WorkSpacesWeb.UpdateIdentityProvider type Rep UpdateIdentityProviderResponse = D1 ('MetaData "UpdateIdentityProviderResponse" "Amazonka.WorkSpacesWeb.UpdateIdentityProvider" "amazonka-workspaces-web-2.0-7elUOg7oNE07CClY3TuUcU" 'False) (C1 ('MetaCons "UpdateIdentityProviderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "identityProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityProvider)))

newUpdateIdentityProviderResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateIdentityProviderResponse'`
-> IdentityProvider	`$sel:identityProvider:UpdateIdentityProviderResponse'`
-> UpdateIdentityProviderResponse

Create a value of UpdateIdentityProviderResponse 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:httpStatus:UpdateIdentityProviderResponse', updateIdentityProviderResponse_httpStatus - The response's http status code.

$sel:identityProvider:UpdateIdentityProviderResponse', updateIdentityProviderResponse_identityProvider - The identity provider.

Response Lenses

updateIdentityProviderResponse_httpStatus :: Lens' UpdateIdentityProviderResponse Int Source #

The response's http status code.

updateIdentityProviderResponse_identityProvider :: Lens' UpdateIdentityProviderResponse IdentityProvider Source #

The identity provider.