AWS.Tools.Finspace.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.Finspace</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet">
            <summary>
            Adds metadata tags to a FinSpace resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) for the resource.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.Tag">
            <summary>
            <para>
            <para>One or more tags to be assigned to the resource.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.TagResourceResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet">
            <summary>
            Returns the FinSpace environment object.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet.EnvironmentId">
            <summary>
            <para>
            <para>The identifier of the FinSpace environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Environment'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.GetEnvironmentResponse).
            Specifying the name of a property of type Amazon.Finspace.Model.GetEnvironmentResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter.
            The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet">
            <summary>
            A list of all of your FinSpace environments.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results to return in this request.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.NextToken">
            <summary>
            <para>
            <para>A token generated by FinSpace that specifies where to continue pagination if a previous
            request was truncated. To get the next set of pages, pass in the nextToken value from
            the response object of the previous page call.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Environments'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListEnvironmentsResponse).
            Specifying the name of a property of type Amazon.Finspace.Model.ListEnvironmentsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet">
            <summary>
            A list of all tags for a resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>The Amazon Resource Name of the resource.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Tags'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListTagsForResourceResponse).
            Specifying the name of a property of type Amazon.Finspace.Model.ListTagsForResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet">
            <summary>
            Create a new FinSpace environment.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_ApplicationCallBackURL">
            <summary>
            <para>
            <para>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity
            provider configuration (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_AttributeMap">
            <summary>
            <para>
            <para>SAML attribute name and value. The name must always be <code>Email</code> and the
            value should be set to the attribute definition in which user email is set. For example,
            name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>.
            Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Description">
            <summary>
            <para>
            <para>The description of the FinSpace environment to be created.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationMode">
            <summary>
            <para>
            <para>Authentication mode for the environment.</para><ul><li><para><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your
            Identity provider.</para></li><li><para><code>LOCAL</code> - Users access FinSpace via email and password managed within
            the FinSpace environment.</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_FederationProviderName">
            <summary>
            <para>
            <para>Name of the identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_FederationURN">
            <summary>
            <para>
            <para>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience
            URI or Service Provider Entity ID.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.KmsKeyId">
            <summary>
            <para>
            <para>The KMS key id to encrypt your data in the FinSpace environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Name">
            <summary>
            <para>
            <para>The name of the FinSpace environment to be created.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataDocument">
            <summary>
            <para>
            <para>SAML 2.0 Metadata document from identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataURL">
            <summary>
            <para>
            <para>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Tag">
            <summary>
            <para>
            <para>Add tags to your FinSpace environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.CreateEnvironmentResponse).
            Specifying the name of a property of type Amazon.Finspace.Model.CreateEnvironmentResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Name parameter.
            The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet">
            <summary>
            Delete an FinSpace environment.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.EnvironmentId">
            <summary>
            <para>
            <para>The identifier for the FinSpace environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.DeleteEnvironmentResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter.
            The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet">
            <summary>
            Removes metadata tags from a FinSpace resource.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.ResourceArn">
            <summary>
            <para>
            <para>A FinSpace resource from which you want to remove a tag or tags. The value for this
            parameter is an Amazon Resource Name (ARN).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.TagKey">
            <summary>
            <para>
            <para>The tag keys (names) of one or more tags to be removed.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.UntagResourceResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet">
            <summary>
            Update your FinSpace environment.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_ApplicationCallBackURL">
            <summary>
            <para>
            <para>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity
            provider configuration (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_AttributeMap">
            <summary>
            <para>
            <para>SAML attribute name and value. The name must always be <code>Email</code> and the
            value should be set to the attribute definition in which user email is set. For example,
            name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>.
            Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Description">
            <summary>
            <para>
            <para>The description of the environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.EnvironmentId">
            <summary>
            <para>
            <para>The identifier of the FinSpace environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationMode">
            <summary>
            <para>
            <para>Authentication mode for the environment.</para><ul><li><para><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your
            Identity provider.</para></li><li><para><code>LOCAL</code> - Users access FinSpace via email and password managed within
            the FinSpace environment.</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_FederationProviderName">
            <summary>
            <para>
            <para>Name of the identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_FederationURN">
            <summary>
            <para>
            <para>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience
            URI or Service Provider Entity ID.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Name">
            <summary>
            <para>
            <para>The name of the environment.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataDocument">
            <summary>
            <para>
            <para>SAML 2.0 Metadata document from identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataURL">
            <summary>
            <para>
            <para>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Environment'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.UpdateEnvironmentResponse).
            Specifying the name of a property of type Amazon.Finspace.Model.UpdateEnvironmentResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter.
            The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>