[ aws . license-manager-user-subscriptions ]

deregister-identity-provider

Description

Deregisters the identity provider from providing user-based subscriptions.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  deregister-identity-provider
--identity-provider <value>
--product <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identity-provider (structure)

An object that specifies details for the identity provider.

ActiveDirectoryIdentityProvider -> (structure)

An object that details an Active Directory identity provider.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

Shorthand Syntax:

ActiveDirectoryIdentityProvider={DirectoryId=string}

JSON Syntax:

{
  "ActiveDirectoryIdentityProvider": {
    "DirectoryId": "string"
  }
}

--product (string)

The name of the user-based subscription product.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

IdentityProviderSummary -> (structure)

Metadata that describes the results of an identity provider operation.

FailureMessage -> (string)

The failure message associated with an identity provider.

IdentityProvider -> (structure)

An object that specifies details for the identity provider.

ActiveDirectoryIdentityProvider -> (structure)

An object that details an Active Directory identity provider.

DirectoryId -> (string)

The directory ID for an Active Directory identity provider.

Product -> (string)

The name of the user-based subscription product.

Status -> (string)

The status of an identity provider.