| 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.FinSpace.Lens
Description
Synopsis
- createEnvironment_dataBundles :: Lens' CreateEnvironment (Maybe [Text])
- createEnvironment_description :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_federationMode :: Lens' CreateEnvironment (Maybe FederationMode)
- createEnvironment_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters)
- createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_superuserParameters :: Lens' CreateEnvironment (Maybe SuperuserParameters)
- createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_name :: Lens' CreateEnvironment Text
- createEnvironmentResponse_environmentArn :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_environmentUrl :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
- deleteEnvironment_environmentId :: Lens' DeleteEnvironment Text
- deleteEnvironmentResponse_httpStatus :: Lens' DeleteEnvironmentResponse Int
- getEnvironment_environmentId :: Lens' GetEnvironment Text
- getEnvironmentResponse_environment :: Lens' GetEnvironmentResponse (Maybe Environment)
- getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int
- listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural)
- listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text)
- listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse (Maybe [Environment])
- listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text)
- listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_federationMode :: Lens' UpdateEnvironment (Maybe FederationMode)
- updateEnvironment_federationParameters :: Lens' UpdateEnvironment (Maybe FederationParameters)
- updateEnvironment_name :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_environmentId :: Lens' UpdateEnvironment Text
- updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse (Maybe Environment)
- updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int
- environment_awsAccountId :: Lens' Environment (Maybe Text)
- environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text)
- environment_description :: Lens' Environment (Maybe Text)
- environment_environmentArn :: Lens' Environment (Maybe Text)
- environment_environmentId :: Lens' Environment (Maybe Text)
- environment_environmentUrl :: Lens' Environment (Maybe Text)
- environment_federationMode :: Lens' Environment (Maybe FederationMode)
- environment_federationParameters :: Lens' Environment (Maybe FederationParameters)
- environment_kmsKeyId :: Lens' Environment (Maybe Text)
- environment_name :: Lens' Environment (Maybe Text)
- environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text)
- environment_status :: Lens' Environment (Maybe EnvironmentStatus)
- federationParameters_applicationCallBackURL :: Lens' FederationParameters (Maybe Text)
- federationParameters_attributeMap :: Lens' FederationParameters (Maybe (HashMap Text Text))
- federationParameters_federationProviderName :: Lens' FederationParameters (Maybe Text)
- federationParameters_federationURN :: Lens' FederationParameters (Maybe Text)
- federationParameters_samlMetadataDocument :: Lens' FederationParameters (Maybe Text)
- federationParameters_samlMetadataURL :: Lens' FederationParameters (Maybe Text)
- superuserParameters_emailAddress :: Lens' SuperuserParameters Text
- superuserParameters_firstName :: Lens' SuperuserParameters Text
- superuserParameters_lastName :: Lens' SuperuserParameters Text
Operations
CreateEnvironment
createEnvironment_dataBundles :: Lens' CreateEnvironment (Maybe [Text]) Source #
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.
createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #
The description of the FinSpace environment to be created.
createEnvironment_federationMode :: Lens' CreateEnvironment (Maybe FederationMode) Source #
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.
createEnvironment_federationParameters :: Lens' CreateEnvironment (Maybe FederationParameters) Source #
Configuration information when authentication mode is FEDERATED.
createEnvironment_kmsKeyId :: Lens' CreateEnvironment (Maybe Text) Source #
The KMS key id to encrypt your data in the FinSpace environment.
createEnvironment_superuserParameters :: Lens' CreateEnvironment (Maybe SuperuserParameters) Source #
Configuration information for the superuser.
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #
Add tags to your FinSpace environment.
createEnvironment_name :: Lens' CreateEnvironment Text Source #
The name of the FinSpace environment to be created.
createEnvironmentResponse_environmentArn :: Lens' CreateEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
createEnvironmentResponse_environmentId :: Lens' CreateEnvironmentResponse (Maybe Text) Source #
The unique identifier for FinSpace environment that you created.
createEnvironmentResponse_environmentUrl :: Lens' CreateEnvironmentResponse (Maybe Text) Source #
The sign-in url for the web application of the FinSpace environment you created.
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #
The response's http status code.
DeleteEnvironment
deleteEnvironment_environmentId :: Lens' DeleteEnvironment Text Source #
The identifier for the FinSpace environment.
deleteEnvironmentResponse_httpStatus :: Lens' DeleteEnvironmentResponse Int Source #
The response's http status code.
GetEnvironment
getEnvironment_environmentId :: Lens' GetEnvironment Text Source #
The identifier of the FinSpace environment.
getEnvironmentResponse_environment :: Lens' GetEnvironmentResponse (Maybe Environment) Source #
The name of the FinSpace environment.
getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int Source #
The response's http status code.
ListEnvironments
listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #
The maximum number of results to return in this request.
listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #
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.
listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse (Maybe [Environment]) Source #
A list of all of your FinSpace environments.
listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #
A token that you can use in a subsequent call to retrieve the next set of results.
listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
A list of all tags for a resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) for the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
One or more tags to be assigned to the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The tag keys (names) of one or more tags to be removed.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateEnvironment
updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text) Source #
The description of the environment.
updateEnvironment_federationMode :: Lens' UpdateEnvironment (Maybe FederationMode) Source #
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.
updateEnvironment_federationParameters :: Lens' UpdateEnvironment (Maybe FederationParameters) Source #
Undocumented member.
updateEnvironment_name :: Lens' UpdateEnvironment (Maybe Text) Source #
The name of the environment.
updateEnvironment_environmentId :: Lens' UpdateEnvironment Text Source #
The identifier of the FinSpace environment.
updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse (Maybe Environment) Source #
Returns the FinSpace environment object.
updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int Source #
The response's http status code.
Types
Environment
environment_awsAccountId :: Lens' Environment (Maybe Text) Source #
The ID of the AWS account in which the FinSpace environment is created.
environment_dedicatedServiceAccountId :: Lens' Environment (Maybe Text) Source #
The AWS account ID of the dedicated service account associated with your FinSpace environment.
environment_description :: Lens' Environment (Maybe Text) Source #
The description of the FinSpace environment.
environment_environmentArn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) of your FinSpace environment.
environment_environmentId :: Lens' Environment (Maybe Text) Source #
The identifier of the FinSpace environment.
environment_environmentUrl :: Lens' Environment (Maybe Text) Source #
The sign-in url for the web application of your FinSpace environment.
environment_federationMode :: Lens' Environment (Maybe FederationMode) Source #
The authentication mode for the environment.
environment_federationParameters :: Lens' Environment (Maybe FederationParameters) Source #
Configuration information when authentication mode is FEDERATED.
environment_kmsKeyId :: Lens' Environment (Maybe Text) Source #
The KMS key id used to encrypt in the FinSpace environment.
environment_name :: Lens' Environment (Maybe Text) Source #
The name of the FinSpace environment.
environment_sageMakerStudioDomainUrl :: Lens' Environment (Maybe Text) Source #
The url of the integrated FinSpace notebook environment in your web application.
environment_status :: Lens' Environment (Maybe EnvironmentStatus) Source #
The current status of creation of the FinSpace environment.
FederationParameters
federationParameters_applicationCallBackURL :: Lens' FederationParameters (Maybe Text) Source #
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
federationParameters_attributeMap :: Lens' FederationParameters (Maybe (HashMap Text Text)) Source #
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.
federationParameters_federationProviderName :: Lens' FederationParameters (Maybe Text) Source #
Name of the identity provider (IdP).
federationParameters_federationURN :: Lens' FederationParameters (Maybe Text) Source #
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
federationParameters_samlMetadataDocument :: Lens' FederationParameters (Maybe Text) Source #
SAML 2.0 Metadata document from identity provider (IdP).
federationParameters_samlMetadataURL :: Lens' FederationParameters (Maybe Text) Source #
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
SuperuserParameters
superuserParameters_emailAddress :: Lens' SuperuserParameters Text Source #
The email address of the superuser.
superuserParameters_firstName :: Lens' SuperuserParameters Text Source #
The first name of the superuser.
superuserParameters_lastName :: Lens' SuperuserParameters Text Source #
The last name of the superuser.