Serialized Form (AWS Java SDK for FinSpace User Environment Management 1.12.382 API)

Package com.amazonaws.services.finspace.model
- Class com.amazonaws.services.finspace.model.AccessDeniedException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.AWSfinspaceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the FinSpace environment to be created.
    - description
```
String description
```
      The description of the FinSpace environment to be created.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key id to encrypt your data in the FinSpace environment.
    - tags
```
Map<K,V> tags
```
      Add tags to your FinSpace environment.
    - federationMode
```
String federationMode
```
      Authentication mode for the environment.
      
      FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
      
      LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    - federationParameters
```
FederationParameters federationParameters
```
      Configuration information when authentication mode is FEDERATED.
    - superuserParameters
```
SuperuserParameters superuserParameters
```
      Configuration information for the superuser.
    - dataBundles
```
List<E> dataBundles
```
      The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
      
      arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
      
      arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
- Class com.amazonaws.services.finspace.model.CreateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - environmentId
```
String environmentId
```
      The unique identifier for FinSpace environment that you created.
    - environmentArn
```
String environmentArn
```
      The Amazon Resource Name (ARN) of the FinSpace environment that you created.
    - environmentUrl
```
String environmentUrl
```
      The sign-in url for the web application of the FinSpace environment you created.
- Class com.amazonaws.services.finspace.model.DeleteEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - environmentId
```
String environmentId
```
      The identifier for the FinSpace environment.
- Class com.amazonaws.services.finspace.model.DeleteEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.finspace.model.Environment extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the FinSpace environment.
    - environmentId
```
String environmentId
```
      The identifier of the FinSpace environment.
    - awsAccountId
```
String awsAccountId
```
      The ID of the AWS account in which the FinSpace environment is created.
    - status
```
String status
```
      The current status of creation of the FinSpace environment.
    - environmentUrl
```
String environmentUrl
```
      The sign-in url for the web application of your FinSpace environment.
    - description
```
String description
```
      The description of the FinSpace environment.
    - environmentArn
```
String environmentArn
```
      The Amazon Resource Name (ARN) of your FinSpace environment.
    - sageMakerStudioDomainUrl
```
String sageMakerStudioDomainUrl
```
      The url of the integrated FinSpace notebook environment in your web application.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key id used to encrypt in the FinSpace environment.
    - dedicatedServiceAccountId
```
String dedicatedServiceAccountId
```
      The AWS account ID of the dedicated service account associated with your FinSpace environment.
    - federationMode
```
String federationMode
```
      The authentication mode for the environment.
    - federationParameters
```
FederationParameters federationParameters
```
      Configuration information when authentication mode is FEDERATED.
- Class com.amazonaws.services.finspace.model.FederationParameters extends Object implements Serializable
  - Serialized Fields
    - samlMetadataDocument
```
String samlMetadataDocument
```
      SAML 2.0 Metadata document from identity provider (IdP).
    - samlMetadataURL
```
String samlMetadataURL
```
      Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
    - applicationCallBackURL
```
String applicationCallBackURL
```
      The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
    - federationURN
```
String federationURN
```
      The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
    - federationProviderName
```
String federationProviderName
```
      Name of the identity provider (IdP).
    - attributeMap
```
Map<K,V> attributeMap
```
      SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
- Class com.amazonaws.services.finspace.model.GetEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - environmentId
```
String environmentId
```
      The identifier of the FinSpace environment.
- Class com.amazonaws.services.finspace.model.GetEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - environment
```
Environment environment
```
      The name of the FinSpace environment.
- Class com.amazonaws.services.finspace.model.InternalServerException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.InvalidRequestException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.LimitExceededException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.ListEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      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.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in this request.
- Class com.amazonaws.services.finspace.model.ListEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - environments
```
List<E> environments
```
      A list of all of your FinSpace environments.
    - nextToken
```
String nextToken
```
      A token that you can use in a subsequent call to retrieve the next set of results.
- Class com.amazonaws.services.finspace.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name of the resource.
- Class com.amazonaws.services.finspace.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      A list of all tags for a resource.
- Class com.amazonaws.services.finspace.model.ResourceNotFoundException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.ServiceQuotaExceededException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.SuperuserParameters extends Object implements Serializable
  - Serialized Fields
    - emailAddress
```
String emailAddress
```
      The email address of the superuser.
    - firstName
```
String firstName
```
      The first name of the superuser.
    - lastName
```
String lastName
```
      The last name of the superuser.
- Class com.amazonaws.services.finspace.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) for the resource.
    - tags
```
Map<K,V> tags
```
      One or more tags to be assigned to the resource.
- Class com.amazonaws.services.finspace.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.finspace.model.ThrottlingException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.finspace.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
    - tagKeys
```
List<E> tagKeys
```
      The tag keys (names) of one or more tags to be removed.
- Class com.amazonaws.services.finspace.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.finspace.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - environmentId
```
String environmentId
```
      The identifier of the FinSpace environment.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      The description of the environment.
    - federationMode
```
String federationMode
```
      Authentication mode for the environment.
      
      FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
      
      LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    - federationParameters
```
FederationParameters federationParameters
```
- Class com.amazonaws.services.finspace.model.UpdateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - environment
```
Environment environment
```
      Returns the FinSpace environment object.
- Class com.amazonaws.services.finspace.model.ValidationException extends AWSfinspaceException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.finspace.model

Class com.amazonaws.services.finspace.model.AccessDeniedException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.AWSfinspaceException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.finspace.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

description

kmsKeyId

tags

federationMode

federationParameters

superuserParameters

dataBundles

Class com.amazonaws.services.finspace.model.CreateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

environmentId

environmentArn

environmentUrl

Class com.amazonaws.services.finspace.model.DeleteEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

Class com.amazonaws.services.finspace.model.DeleteEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.finspace.model.Environment extends Object implements Serializable

Serialized Fields

name

environmentId

awsAccountId

status

environmentUrl

description

environmentArn

sageMakerStudioDomainUrl

kmsKeyId

dedicatedServiceAccountId

federationMode

federationParameters

Class com.amazonaws.services.finspace.model.FederationParameters extends Object implements Serializable

Serialized Fields

samlMetadataDocument

samlMetadataURL

applicationCallBackURL

federationURN

federationProviderName

attributeMap

Class com.amazonaws.services.finspace.model.GetEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

environmentId

Class com.amazonaws.services.finspace.model.GetEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

environment

Class com.amazonaws.services.finspace.model.InternalServerException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.InvalidRequestException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.LimitExceededException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.ListEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

maxResults

Class com.amazonaws.services.finspace.model.ListEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

environments

nextToken

Class com.amazonaws.services.finspace.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

Class com.amazonaws.services.finspace.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

tags

Class com.amazonaws.services.finspace.model.ResourceNotFoundException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.ServiceQuotaExceededException extends AWSfinspaceException implements Serializable

Class com.amazonaws.services.finspace.model.SuperuserParameters extends Object implements Serializable

Serialized Fields

emailAddress

firstName

lastName

Class com.amazonaws.services.finspace.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

tags

Class com.amazonaws.services.finspace.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable