semvec/pypi-packages huggingface dataset:
nodeum-sdk 1.88.0
Nodeum API
Keywords: OpenAPI,OpenAPI-Generator,Nodeum API

The Nodeum API makes it easy to tap into the digital data mesh that runs across your organisation. Make requests to our API endpoints and we’ll give you everything you need to interconnect your business workflows with your storage.  All production API requests are made to:  http://nodeumhostname/api/  The current production version of the API is v1.   **REST** The Nodeum API is a RESTful API. This means that the API is designed to allow you to get, create, update, &amp; delete objects with the HTTP verbs GET, POST, PUT, PATCH, &amp; DELETE.  **JSON** The Nodeum API speaks exclusively in JSON. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API.  **Authentication** All API calls require user-password authentication.   **Cross-Origin Resource Sharing** The Nodeum API supports CORS for communicating from Javascript for these endpoints. You will need to specify an Origin URI when creating your application to allow for CORS to be whitelisted for your domain.   **Pagination** Some endpoints such as File Listing return a potentially lengthy array of objects. In order to keep the response sizes manageable the API will take advantage of pagination. Pagination is a mechanism for returning a subset of the results for a request and allowing for subsequent requests to “page” through the rest of the results until the end is reached. Paginated endpoints follow a standard interface that accepts two query parameters, limit and offset, and return a payload that follows a standard form. These parameters names and their behavior are borrowed from SQL LIMIT and OFFSET keywords.  **Versioning** The Nodeum API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented.   However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them. These include:  - Adding new endpoints to the API - Adding new attributes to the response of an existing endpoint - Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs)  **Filter parameters** When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:  - &#x60;&#x3D;&#x60; value is equal. Default operator, may be omitted  - &#x60;!&#x3D;&#x60; value is different  - &#x60;&gt;&#x60; greater than  - &#x60;&gt;&#x3D;&#x60; greater than or equal  - &#x60;&lt;&#x60; lower than  - &#x60;&gt;&#x3D;&#x60; lower than or equal  - &#x60;&gt;&lt;&#x60; included in list, items should be separated by &#x60;|&#x60;  - &#x60;!&gt;&lt;&#x60; not included in list, items should be separated by &#x60;|&#x60;  - &#x60;~&#x60; pattern matching, may include &#x60;%&#x60; (any characters) and &#x60;_&#x60; (one character)  - &#x60;!~&#x60; pattern not matching, may include &#x60;%&#x60; (any characters) and &#x60;_&#x60; (one character)    # noqa: E501
awssamlpy3 1.0.8.3
SAML federated API access for AWS

As part of AWS Governance to enhance the security with the accounts and IAM users, Federated API access is recommended for AWS resources instead of hard-coded IAM AccessID and SecretKeys in the config file.

# Steps:

- If this is the first time install of this python package, use below command:

		For Python2.x version, pip install awssamlpy2
		For Python3.x version, pip install awssamlpy3

- To upgrade this python package to latest version, use below command:

		For Python2.x version, pip install awssamlpy2 --upgrade
		For Python3.x version, pip install awssamlpy3 --upgrade

- Create a '.awssaml.properties' (~/.awssaml.properties) file under your user home directory like below -

		[UserProp]
		aws-region=us-east-1
		aws-outputformat=json
		idpurl=https://<Your Company AWS SAML Domain>/adfs/ls/IdpInitiatedSignOn.aspx?loginToRp=urn:amazon:webservices

	Please refer to Mesh DOC-111675 for the idpurl

- Create a 'configure' file under ~/.aws directory without providing the values for access and secret keys. Dont worry if haven't yet; the package will automatically create one if this file is not present. You may just choose the output and region fields as per your need.

		[default]
		output = json
		region = us-east-1
		aws_access_key_id =
		aws_secret_access_key =

- We have taken care to package the required modules. But if there are any additional packages required, install the missing modules based on the error encountered like below:

        On Linux, pip install <module>
            Eg: pip install requests

        On Windows, easy_install <module>
            Eg: easy_install requests

- Whenever you need SAML access to your AWS services, just the command:

		aws-saml 

- This does the following:

        - Verifies your ~/.aws/configure file to set the approriate region; OR creates one if its not present

		- Prompts the user for AD username/password and does SAML auth with our ADFS
                    NOTE: Username has to be in the format <domain>\<networkID>

		- Based on SAML response, prompts the user to choose the roles available on AWS for that user

		- Then, stores the temporarily created credentials (using Amazon STS service) for the user in the ~/.aws/credentials file along with STS token

		- Use API calls to work on AWS resources

		- Sample API call used in the script is for listing the S3 buckets, which is in Boto2.x format