QBusiness / Client / get_data_accessor

get_data_accessor

QBusiness.Client.get_data_accessor(**kwargs)

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

See also: AWS API Documentation

Request Syntax

response = client.get_data_accessor(
    applicationId='string',
    dataAccessorId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The unique identifier of the Amazon Q Business application.

  • dataAccessorId (string) –

    [REQUIRED]

    The unique identifier of the data accessor to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'displayName': 'string',
    'dataAccessorId': 'string',
    'dataAccessorArn': 'string',
    'applicationId': 'string',
    'idcApplicationArn': 'string',
    'principal': 'string',
    'actionConfigurations': [
        {
            'action': 'string',
            'filterConfiguration': {
                'documentAttributeFilter': {
                    'andAllFilters': [
                        {'... recursive ...'},
                    ],
                    'orAllFilters': [
                        {'... recursive ...'},
                    ],
                    'notFilter': {'... recursive ...'},
                    'equalsTo': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'containsAll': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'containsAny': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'greaterThan': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'greaterThanOrEquals': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'lessThan': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    },
                    'lessThanOrEquals': {
                        'name': 'string',
                        'value': {
                            'stringValue': 'string',
                            'stringListValue': [
                                'string',
                            ],
                            'longValue': 123,
                            'dateValue': datetime(2015, 1, 1)
                        }
                    }
                }
            }
        },
    ],
    'authenticationDetail': {
        'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
        'authenticationConfiguration': {
            'idcTrustedTokenIssuerConfiguration': {
                'idcTrustedTokenIssuerArn': 'string'
            }
        },
        'externalIds': [
            'string',
        ]
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • displayName (string) –

      The friendly name of the data accessor.

    • dataAccessorId (string) –

      The unique identifier of the data accessor.

    • dataAccessorArn (string) –

      The Amazon Resource Name (ARN) of the data accessor.

    • applicationId (string) –

      The unique identifier of the Amazon Q Business application associated with this data accessor.

    • idcApplicationArn (string) –

      The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.

    • principal (string) –

      The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

    • actionConfigurations (list) –

      The list of action configurations specifying the allowed actions and any associated filters.

      • (dict) –

        Specifies an allowed action and its associated filter configuration.

        • action (string) –

          The Amazon Q Business action that is allowed.

        • filterConfiguration (dict) –

          The filter configuration for the action, if any.

          • documentAttributeFilter (dict) –

            Enables filtering of responses based on document attributes or metadata fields.

            • andAllFilters (list) –

              Performs a logical AND operation on all supplied filters.

              • (dict) –

                Enables filtering of responses based on document attributes or metadata fields.

            • orAllFilters (list) –

              Performs a logical OR operation on all supplied filters.

              • (dict) –

                Enables filtering of responses based on document attributes or metadata fields.

            • notFilter (dict) –

              Performs a logical NOT operation on all supplied filters.

            • equalsTo (dict) –

              Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • containsAll (dict) –

              Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • containsAny (dict) –

              Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • greaterThan (dict) –

              Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • greaterThanOrEquals (dict) –

              Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • lessThan (dict) –

              Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

            • lessThanOrEquals (dict) –

              Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

              • name (string) –

                The identifier for the attribute.

              • value (dict) –

                The value of the attribute.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, longValue, dateValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • stringValue (string) –

                  A string.

                • stringListValue (list) –

                  A list of strings.

                  • (string) –

                • longValue (integer) –

                  A long integer value.

                • dateValue (datetime) –

                  A date expressed as an ISO 8601 string.

                  It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

    • authenticationDetail (dict) –

      The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.

      • authenticationType (string) –

        The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

        • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

        • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

      • authenticationConfiguration (dict) –

        The specific authentication configuration based on the authentication type.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: idcTrustedTokenIssuerConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • idcTrustedTokenIssuerConfiguration (dict) –

          Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.

          • idcTrustedTokenIssuerArn (string) –

            The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.

      • externalIds (list) –

        A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.

        • (string) –

    • createdAt (datetime) –

      The timestamp when the data accessor was created.

    • updatedAt (datetime) –

      The timestamp when the data accessor was last updated.

Exceptions