Amazonka.WorkSpaces.ModifySamlProperties

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Creating a Request

data ModifySamlProperties

See: newModifySamlProperties smart constructor.

Constructors

ModifySamlProperties'

Fields

• propertiesToDelete :: Maybe [DeletableSamlProperty]

  The SAML properties to delete as part of your request.

  Specify one of the following options:

  • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
  • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.
• samlProperties :: Maybe SamlProperties

  The properties for configuring SAML 2.0 authentication.

• resourceId :: Text

  The directory identifier for which you want to configure SAML properties.

Instances

ToJSON ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

toJSON :: ModifySamlProperties -> Value

toEncoding :: ModifySamlProperties -> Encoding

toJSONList :: [ModifySamlProperties] -> Value

toEncodingList :: [ModifySamlProperties] -> Encoding

ToHeaders ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

toHeaders :: ModifySamlProperties -> [Header]

ToPath ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

toPath :: ModifySamlProperties -> ByteString

ToQuery ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

toQuery :: ModifySamlProperties -> QueryString

AWSRequest ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Associated Types

type AWSResponse ModifySamlProperties

Methods

request :: (Service -> Service) -> ModifySamlProperties -> Request ModifySamlProperties

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifySamlProperties -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifySamlProperties)))

Generic ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Associated Types

type Rep ModifySamlProperties :: Type -> Type

Methods

from :: ModifySamlProperties -> Rep ModifySamlProperties x

to :: Rep ModifySamlProperties x -> ModifySamlProperties

Read ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

readsPrec :: Int -> ReadS ModifySamlProperties

readList :: ReadS [ModifySamlProperties]

readPrec :: ReadPrec ModifySamlProperties

readListPrec :: ReadPrec [ModifySamlProperties]

Show ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

showsPrec :: Int -> ModifySamlProperties -> ShowS

show :: ModifySamlProperties -> String

showList :: [ModifySamlProperties] -> ShowS

NFData ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

rnf :: ModifySamlProperties -> ()

Eq ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

(==) :: ModifySamlProperties -> ModifySamlProperties -> Bool

(/=) :: ModifySamlProperties -> ModifySamlProperties -> Bool

Hashable ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

hashWithSalt :: Int -> ModifySamlProperties -> Int

hash :: ModifySamlProperties -> Int

type AWSResponse ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

type AWSResponse ModifySamlProperties = ModifySamlPropertiesResponse

type Rep ModifySamlProperties

Defined in Amazonka.WorkSpaces.ModifySamlProperties

type Rep ModifySamlProperties = D1 ('MetaData "ModifySamlProperties" "Amazonka.WorkSpaces.ModifySamlProperties" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ModifySamlProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "propertiesToDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeletableSamlProperty])) :*: (S1 ('MetaSel ('Just "samlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamlProperties)) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifySamlProperties

Arguments

:: Text

ModifySamlProperties

-> ModifySamlProperties

Create a value of ModifySamlProperties 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:propertiesToDelete:ModifySamlProperties', modifySamlProperties_propertiesToDelete - The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

ModifySamlProperties, modifySamlProperties_samlProperties - The properties for configuring SAML 2.0 authentication.

ModifySamlProperties, modifySamlProperties_resourceId - The directory identifier for which you want to configure SAML properties.

Request Lenses

modifySamlProperties_propertiesToDelete :: Lens' ModifySamlProperties (Maybe [DeletableSamlProperty])

The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

modifySamlProperties_samlProperties :: Lens' ModifySamlProperties (Maybe SamlProperties)

The properties for configuring SAML 2.0 authentication.

modifySamlProperties_resourceId :: Lens' ModifySamlProperties Text

The directory identifier for which you want to configure SAML properties.

Destructuring the Response

data ModifySamlPropertiesResponse

See: newModifySamlPropertiesResponse smart constructor.

Constructors

ModifySamlPropertiesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Associated Types

type Rep ModifySamlPropertiesResponse :: Type -> Type

Methods

from :: ModifySamlPropertiesResponse -> Rep ModifySamlPropertiesResponse x

to :: Rep ModifySamlPropertiesResponse x -> ModifySamlPropertiesResponse

Read ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

readsPrec :: Int -> ReadS ModifySamlPropertiesResponse

readList :: ReadS [ModifySamlPropertiesResponse]

readPrec :: ReadPrec ModifySamlPropertiesResponse

readListPrec :: ReadPrec [ModifySamlPropertiesResponse]

Show ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

showsPrec :: Int -> ModifySamlPropertiesResponse -> ShowS

show :: ModifySamlPropertiesResponse -> String

showList :: [ModifySamlPropertiesResponse] -> ShowS

NFData ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

rnf :: ModifySamlPropertiesResponse -> ()

Eq ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

Methods

(==) :: ModifySamlPropertiesResponse -> ModifySamlPropertiesResponse -> Bool

(/=) :: ModifySamlPropertiesResponse -> ModifySamlPropertiesResponse -> Bool

type Rep ModifySamlPropertiesResponse

Defined in Amazonka.WorkSpaces.ModifySamlProperties

type Rep ModifySamlPropertiesResponse = D1 ('MetaData "ModifySamlPropertiesResponse" "Amazonka.WorkSpaces.ModifySamlProperties" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ModifySamlPropertiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifySamlPropertiesResponse

Arguments

:: Int

$sel:httpStatus:ModifySamlPropertiesResponse'

-> ModifySamlPropertiesResponse

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

Response Lenses

modifySamlPropertiesResponse_httpStatus :: Lens' ModifySamlPropertiesResponse Int

The response's http status code.